NAV Navigation

📣 We're improving the Web API docs. Check out a preview.

Shell HTTP JavaScript Ruby Python PHP Java Go

TERMINALFOUR REST API v8.3.16-FINAL

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:

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": null,
      "subMinor": null,
      "major": null,
      "minor": null
    },
    "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/>
      <subMinor/>
      <major/>
      <minor/>
    </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": null,
      "subMinor": null,
      "major": null,
      "minor": null
    },
    "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/>
      <subMinor/>
      <major/>
      <minor/>
    </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": null,
        "serviceID": null,
        "name": null,
        "value": null,
        "enabled": null
      }
    ]
  }
]

<?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/>
  <serviceID/>
  <name/>
  <value/>
  <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

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

Example responses

200 Response

[
  {
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "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
    },
    "childIDs": [
      0
    ],
    "assignedChannels": [
      {
        "id": null,
        "serviceID": null,
        "language": null,
        "accountID": null,
        "channelID": null
      }
    ],
    "details": [
      {
        "id": null,
        "accountID": null,
        "name": null,
        "value": null,
        "enabled": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</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>
<childIDs>0</childIDs>
<assignedChannels>
  <id/>
  <serviceID/>
  <language/>
  <accountID/>
  <channelID/>
</assignedChannels>
<details>
  <id/>
  <accountID/>
  <name/>
  <value/>
  <enabled/>
</details>

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
» details [AnalyticsAccountDetail] false none none

addAccount

POST /analytics/{serviceID}/account

Parameters

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

Example responses

200 Response

{
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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
  },
  "childIDs": [
    0
  ],
  "assignedChannels": [
    {
      "id": {},
      "serviceID": 0,
      "language": "string",
      "accountID": 0,
      "channelID": 0
    }
  ],
  "details": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsAccountDTO>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </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>
  <childIDs>0</childIDs>
  <assignedChannels>
    <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>
</AnalyticsAccountDTO>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsAccountDTO

getAccount

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

Parameters

Name 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": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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
  },
  "childIDs": [
    0
  ],
  "assignedChannels": [
    {
      "id": {},
      "serviceID": 0,
      "language": "string",
      "accountID": 0,
      "channelID": 0
    }
  ],
  "details": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsAccountDTO>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </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>
  <childIDs>0</childIDs>
  <assignedChannels>
    <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>
</AnalyticsAccountDTO>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsAccountDTO

modifyAccount

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

Parameters

Name 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": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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
  },
  "childIDs": [
    0
  ],
  "assignedChannels": [
    {
      "id": {},
      "serviceID": 0,
      "language": "string",
      "accountID": 0,
      "channelID": 0
    }
  ],
  "details": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsAccountDTO>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </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>
  <childIDs>0</childIDs>
  <assignedChannels>
    <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>
</AnalyticsAccountDTO>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsAccountDTO

deleteAccount

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

Parameters

Name 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

Name 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

Name 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

apikey

listAPIKeys

GET /apikey

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "active": true,
    "deleted": true,
    "secret": [
      "string"
    ],
    "userId": 0,
    "lastModifiedBy": 0,
    "dateModified": "2019-08-24T14:15:22Z",
    "dateCreated": "2019-08-24T14:15:22Z",
    "invalidationDate": "2019-08-24T14:15:22Z",
    "expired": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<active>true</active>
<deleted>true</deleted>
<secret>string</secret>
<userId>0</userId>
<lastModifiedBy>0</lastModifiedBy>
<dateModified>2019-08-24T14:15:22Z</dateModified>
<dateCreated>2019-08-24T14:15:22Z</dateCreated>
<invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
<expired>true</expired>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

createAPIKey

POST /apikey

Example responses

200 Response

{
  "apiKeyMetadata": {
    "id": 0,
    "name": "string",
    "active": true,
    "deleted": true,
    "secret": [
      "string"
    ],
    "userId": 0,
    "lastModifiedBy": 0,
    "dateModified": "2019-08-24T14:15:22Z",
    "dateCreated": "2019-08-24T14:15:22Z",
    "invalidationDate": "2019-08-24T14:15:22Z",
    "expired": true
  },
  "apiKey": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<InitialAPIKeyDTO>
  <apiKeyMetadata>
    <id>0</id>
    <name>string</name>
    <active>true</active>
    <deleted>true</deleted>
    <secret>string</secret>
    <userId>0</userId>
    <lastModifiedBy>0</lastModifiedBy>
    <dateModified>2019-08-24T14:15:22Z</dateModified>
    <dateCreated>2019-08-24T14:15:22Z</dateCreated>
    <invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
    <expired>true</expired>
  </apiKeyMetadata>
  <apiKey>string</apiKey>
</InitialAPIKeyDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InitialAPIKeyDTO

listExistingAPIKeys

GET /apikey/existing

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "active": true,
    "deleted": true,
    "secret": [
      "string"
    ],
    "userId": 0,
    "lastModifiedBy": 0,
    "dateModified": "2019-08-24T14:15:22Z",
    "dateCreated": "2019-08-24T14:15:22Z",
    "invalidationDate": "2019-08-24T14:15:22Z",
    "expired": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<active>true</active>
<deleted>true</deleted>
<secret>string</secret>
<userId>0</userId>
<lastModifiedBy>0</lastModifiedBy>
<dateModified>2019-08-24T14:15:22Z</dateModified>
<dateCreated>2019-08-24T14:15:22Z</dateCreated>
<invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
<expired>true</expired>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

list

POST /apikey/list

Example responses

200 Response

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "id": 0,
      "name": "string",
      "active": true,
      "deleted": true,
      "secret": [
        null
      ],
      "userId": 0,
      "lastModifiedBy": 0,
      "dateModified": "2019-08-24T14:15:22Z",
      "dateCreated": "2019-08-24T14:15:22Z",
      "invalidationDate": "2019-08-24T14:15:22Z",
      "expired": true
    }
  ],
  "error": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<TableDataResponseStructureAPIKeyDTO>
  <draw>0</draw>
  <recordsTotal>0</recordsTotal>
  <recordsFiltered>0</recordsFiltered>
  <data>
    <id>0</id>
    <name>string</name>
    <active>true</active>
    <deleted>true</deleted>
    <secret/>
    <userId>0</userId>
    <lastModifiedBy>0</lastModifiedBy>
    <dateModified>2019-08-24T14:15:22Z</dateModified>
    <dateCreated>2019-08-24T14:15:22Z</dateCreated>
    <invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
    <expired>true</expired>
  </data>
  <error>string</error>
</TableDataResponseStructureAPIKeyDTO>

Responses

Status Meaning Description Schema
200 OK successful operation TableDataResponseStructureAPIKeyDTO

listByUser

GET /apikey/list/{user}

Parameters

Name In Type Required Description
user path integer(int32) true none
startAt query integer(int32) false none
fetch query integer(int32) false none
filterBy query string false none
sortBy query string false none
inOrder query string false none
deleted query boolean false none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "active": true,
    "deleted": true,
    "secret": [
      "string"
    ],
    "userId": 0,
    "lastModifiedBy": 0,
    "dateModified": "2019-08-24T14:15:22Z",
    "dateCreated": "2019-08-24T14:15:22Z",
    "invalidationDate": "2019-08-24T14:15:22Z",
    "expired": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<active>true</active>
<deleted>true</deleted>
<secret>string</secret>
<userId>0</userId>
<lastModifiedBy>0</lastModifiedBy>
<dateModified>2019-08-24T14:15:22Z</dateModified>
<dateCreated>2019-08-24T14:15:22Z</dateCreated>
<invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
<expired>true</expired>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getAPIKey

GET /apikey/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "active": true,
  "deleted": true,
  "secret": [
    "string"
  ],
  "userId": 0,
  "lastModifiedBy": 0,
  "dateModified": "2019-08-24T14:15:22Z",
  "dateCreated": "2019-08-24T14:15:22Z",
  "invalidationDate": "2019-08-24T14:15:22Z",
  "expired": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<APIKeyDTO>
  <id>0</id>
  <name>string</name>
  <active>true</active>
  <deleted>true</deleted>
  <secret>string</secret>
  <userId>0</userId>
  <lastModifiedBy>0</lastModifiedBy>
  <dateModified>2019-08-24T14:15:22Z</dateModified>
  <dateCreated>2019-08-24T14:15:22Z</dateCreated>
  <invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
  <expired>true</expired>
</APIKeyDTO>

Responses

Status Meaning Description Schema
200 OK successful operation APIKeyDTO

modifyAPIKey

PUT /apikey/{id}

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "active": true,
  "deleted": true,
  "secret": [
    "string"
  ],
  "userId": 0,
  "lastModifiedBy": 0,
  "dateModified": "2019-08-24T14:15:22Z",
  "dateCreated": "2019-08-24T14:15:22Z",
  "invalidationDate": "2019-08-24T14:15:22Z",
  "expired": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<APIKeyDTO>
  <id>0</id>
  <name>string</name>
  <active>true</active>
  <deleted>true</deleted>
  <secret>string</secret>
  <userId>0</userId>
  <lastModifiedBy>0</lastModifiedBy>
  <dateModified>2019-08-24T14:15:22Z</dateModified>
  <dateCreated>2019-08-24T14:15:22Z</dateCreated>
  <invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
  <expired>true</expired>
</APIKeyDTO>

Responses

Status Meaning Description Schema
200 OK successful operation APIKeyDTO

deleteAPIKey

DELETE /apikey/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

patchAPIKey

PATCH /apikey/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "active": true,
  "deleted": true,
  "secret": [
    "string"
  ],
  "userId": 0,
  "lastModifiedBy": 0,
  "dateModified": "2019-08-24T14:15:22Z",
  "dateCreated": "2019-08-24T14:15:22Z",
  "invalidationDate": "2019-08-24T14:15:22Z",
  "expired": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<APIKeyDTO>
  <id>0</id>
  <name>string</name>
  <active>true</active>
  <deleted>true</deleted>
  <secret>string</secret>
  <userId>0</userId>
  <lastModifiedBy>0</lastModifiedBy>
  <dateModified>2019-08-24T14:15:22Z</dateModified>
  <dateCreated>2019-08-24T14:15:22Z</dateCreated>
  <invalidationDate>2019-08-24T14:15:22Z</invalidationDate>
  <expired>true</expired>
</APIKeyDTO>

Responses

Status Meaning Description Schema
200 OK successful operation APIKeyDTO

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

Name 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

Name 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

Name In Type Required Description
language path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

getListAndItems

GET /automirrorcontentconfig/{language}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

[
  {
    "listID": 0,
    "listName": "string",
    "language": "string",
    "items": [
      {
        "id": null,
        "name": null,
        "sectionID": null
      }
    ],
    "mirror": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<listID>0</listID>
<listName>string</listName>
<language>string</language>
<items>
  <id/>
  <name/>
  <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-08-24T14:15:22Z",
  "nextDue": "2019-08-24T14:15:22Z",
  "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": [
      "string"
    ],
    "recipients": [
      0
    ]
  },
  "parameters": {
    "property1": {
      "scheduledJob": {},
      "key": "string",
      "value": "string"
    },
    "property2": {
      "scheduledJob": {},
      "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-08-24T14:15:22Z</creationDate>
  <nextDue>2019-08-24T14:15:22Z</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>string</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

Name 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": [
      {
        "id": null,
        "name": null,
        "description": null,
        "pendingVersionOutputDir": null,
        "rootSectionID": null,
        "hasPendingVersion": null,
        "editable": null,
        "microSites": null,
        "parentID": 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>
  <id/>
  <name/>
  <description/>
  <pendingVersionOutputDir/>
  <rootSectionID/>
  <hasPendingVersion/>
  <editable/>
  <microSites/>
  <parentID/>
</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

getDefaultChannelPreviewIDsForCurrentUser

POST /channel/defaultPreviewIDs

Example responses

200 Response

[
  0
]

<?xml version="1.0" encoding="UTF-8" ?>0

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

validatePxlFolder

POST /channel/inputvalidation/channelpxlfolder

Example responses

200 Response

{
  "value": "string",
  "inputIsValid": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<ChannelPxlFolderDTO>
  <value>string</value>
  <inputIsValid>true</inputIsValid>
</ChannelPxlFolderDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ChannelPxlFolderDTO

getPageLayout

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

Parameters

Name 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

Name 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": [
      {
        "id": null,
        "name": null,
        "description": null,
        "pendingVersionOutputDir": null,
        "rootSectionID": null,
        "hasPendingVersion": null,
        "editable": null,
        "microSites": null,
        "parentID": 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>
  <id/>
  <name/>
  <description/>
  <pendingVersionOutputDir/>
  <rootSectionID/>
  <hasPendingVersion/>
  <editable/>
  <microSites/>
  <parentID/>
</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

Name 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

Name 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

Name 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

Name 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

Name 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

Name 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

Name 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

Name 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

Name 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": [
        null
      ],
      "valueMap": [
        null
      ]
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<ConfigurationOptions>
  <options>
    <name>string</name>
    <type>string</type>
    <value/>
    <valueList/>
    <valueMap/>
  </options>
</ConfigurationOptions>

Responses

Status Meaning Description Schema
200 OK successful operation ConfigurationOptions

addOrModify

PUT /config/{key}

Parameters

Name 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

Name In Type Required Description
key path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /config/{key}

Parameters

Name 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

Name In Type Required Description
key path string true none

Example responses

200 Response

{
  "options": [
    {
      "name": "string",
      "type": "string",
      "value": {},
      "valueList": [
        null
      ],
      "valueMap": [
        null
      ]
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<ConfigurationOptions>
  <options>
    <name>string</name>
    <type>string</type>
    <value/>
    <valueList/>
    <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

Name In Type Required Description
languageCode path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "language": "string",
    "sections": [
      {
        "id": null,
        "level": null,
        "status": null,
        "printSequence": null,
        "formSection": null,
        "archived": null,
        "users": null,
        "viewUsers": null,
        "groups": null,
        "viewGroups": null,
        "contentSections": null,
        "sectionInfos": null,
        "mirrorSections": null,
        "links": null,
        "rootChannels": null,
        "appliedPageLayouts": null,
        "hierarchyMirrorAcOpt": null,
        "hierarchyMirrorMetadataOpt": null,
        "children": null,
        "contentTypeScopes": null,
        "cloneSource": null,
        "sectionPaths": null,
        "sortLock": null,
        "parent": null,
        "mirrors": null,
        "root": null,
        "shown": null,
        "nextSequence": null,
        "entityID": null,
        "childOfMirrored": null,
        "metadataOption": null,
        "workflowID": null,
        "childOfMirror": null,
        "workflowName": null,
        "workflow": null,
        "channelRoot": null,
        "languages": null,
        "channels": null,
        "pathMembers": null,
        "sectionSortMethod": null,
        "contentSortMethod": null,
        "contentsAndSequences": null,
        "parentWorkflowID": null,
        "inheritedPageLayouts": null,
        "currentOrInheritedWorkflow": null,
        "contentNextSequence": null,
        "accessControlOption": null,
        "parentID": null,
        "mirror": null,
        "allNames": null,
        "languageCount": null,
        "mirrorSource": null,
        "link": null,
        "mirrorSourceID": null
      }
    ],
    "lastModified": "string",
    "media": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<language>string</language>
<sections>
  <id/>
  <level/>
  <status/>
  <printSequence/>
  <formSection/>
  <archived/>
  <users/>
  <viewUsers/>
  <groups/>
  <viewGroups/>
  <contentSections/>
  <sectionInfos/>
  <mirrorSections/>
  <links/>
  <rootChannels/>
  <appliedPageLayouts/>
  <hierarchyMirrorAcOpt/>
  <hierarchyMirrorMetadataOpt/>
  <children/>
  <contentTypeScopes/>
  <cloneSource/>
  <sectionPaths/>
  <sortLock/>
  <parent/>
  <mirrors/>
  <root/>
  <shown/>
  <nextSequence/>
  <entityID/>
  <childOfMirrored/>
  <metadataOption/>
  <workflowID/>
  <childOfMirror/>
  <workflowName/>
  <workflow/>
  <channelRoot/>
  <languages/>
  <channels/>
  <pathMembers/>
  <sectionSortMethod/>
  <contentSortMethod/>
  <contentsAndSequences/>
  <parentWorkflowID/>
  <inheritedPageLayouts/>
  <currentOrInheritedWorkflow/>
  <contentNextSequence/>
  <accessControlOption/>
  <parentID/>
  <mirror/>
  <allNames/>
  <languageCount/>
  <mirrorSource/>
  <link/>
  <mirrorSourceID/>
</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
»»»»»»»» channelIDs [integer] false none none
»»»»»»»» sectionIDs [integer] false none none
»»»»»»»» languageCount integer(int32) false none none
»»»»»»» mediaTypesWithPublishRuleCategory [integer] false none none
»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»» personalisationEnabled boolean false none none
»»»»»»» accessControlEnabled boolean false none none
»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»» parentID integer(int32) false none none
»»»»»»» contentIDs [integer] false none none
»»»»»»» languageCodes [string] false none none
»»»»»»» microSite boolean false none none
»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»» alias string false none none
»»»»»»»» directEditEnabled boolean false none none
»»»» deleted boolean false none none
»»»» memberCount integer(int32) false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
»»»»» value string false none none
»»»»» language string false none none
»»»»» sectionID integer(int32) false none none
»»»»» metaTagName string false none none
»»»»» metaTagID 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

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

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "language": "string",
    "sections": [
      {
        "id": null,
        "level": null,
        "status": null,
        "printSequence": null,
        "formSection": null,
        "archived": null,
        "users": null,
        "viewUsers": null,
        "groups": null,
        "viewGroups": null,
        "contentSections": null,
        "sectionInfos": null,
        "mirrorSections": null,
        "links": null,
        "rootChannels": null,
        "appliedPageLayouts": null,
        "hierarchyMirrorAcOpt": null,
        "hierarchyMirrorMetadataOpt": null,
        "children": null,
        "contentTypeScopes": null,
        "cloneSource": null,
        "sectionPaths": null,
        "sortLock": null,
        "parent": null,
        "mirrors": null,
        "root": null,
        "shown": null,
        "nextSequence": null,
        "entityID": null,
        "childOfMirrored": null,
        "metadataOption": null,
        "workflowID": null,
        "childOfMirror": null,
        "workflowName": null,
        "workflow": null,
        "channelRoot": null,
        "languages": null,
        "channels": null,
        "pathMembers": null,
        "sectionSortMethod": null,
        "contentSortMethod": null,
        "contentsAndSequences": null,
        "parentWorkflowID": null,
        "inheritedPageLayouts": null,
        "currentOrInheritedWorkflow": null,
        "contentNextSequence": null,
        "accessControlOption": null,
        "parentID": null,
        "mirror": null,
        "allNames": null,
        "languageCount": null,
        "mirrorSource": null,
        "link": null,
        "mirrorSourceID": null
      }
    ],
    "lastModified": "string",
    "media": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<language>string</language>
<sections>
  <id/>
  <level/>
  <status/>
  <printSequence/>
  <formSection/>
  <archived/>
  <users/>
  <viewUsers/>
  <groups/>
  <viewGroups/>
  <contentSections/>
  <sectionInfos/>
  <mirrorSections/>
  <links/>
  <rootChannels/>
  <appliedPageLayouts/>
  <hierarchyMirrorAcOpt/>
  <hierarchyMirrorMetadataOpt/>
  <children/>
  <contentTypeScopes/>
  <cloneSource/>
  <sectionPaths/>
  <sortLock/>
  <parent/>
  <mirrors/>
  <root/>
  <shown/>
  <nextSequence/>
  <entityID/>
  <childOfMirrored/>
  <metadataOption/>
  <workflowID/>
  <childOfMirror/>
  <workflowName/>
  <workflow/>
  <channelRoot/>
  <languages/>
  <channels/>
  <pathMembers/>
  <sectionSortMethod/>
  <contentSortMethod/>
  <contentsAndSequences/>
  <parentWorkflowID/>
  <inheritedPageLayouts/>
  <currentOrInheritedWorkflow/>
  <contentNextSequence/>
  <accessControlOption/>
  <parentID/>
  <mirror/>
  <allNames/>
  <languageCount/>
  <mirrorSource/>
  <link/>
  <mirrorSourceID/>
</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
»»»»»»»» channelIDs [integer] false none none
»»»»»»»» sectionIDs [integer] false none none
»»»»»»»» languageCount integer(int32) false none none
»»»»»»» mediaTypesWithPublishRuleCategory [integer] false none none
»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»» personalisationEnabled boolean false none none
»»»»»»» accessControlEnabled boolean false none none
»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»» parentID integer(int32) false none none
»»»»»»» contentIDs [integer] false none none
»»»»»»» languageCodes [string] false none none
»»»»»»» microSite boolean false none none
»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»» alias string false none none
»»»»»»»» directEditEnabled boolean false none none
»»»» deleted boolean false none none
»»»» memberCount integer(int32) false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
»»»»» value string false none none
»»»»» language string false none none
»»»»» sectionID integer(int32) false none none
»»»»» metaTagName string false none none
»»»»» metaTagID 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

Name In Type Required Description
languageCode path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "language": "string",
    "sections": [
      {
        "id": null,
        "level": null,
        "status": null,
        "printSequence": null,
        "formSection": null,
        "archived": null,
        "users": null,
        "viewUsers": null,
        "groups": null,
        "viewGroups": null,
        "contentSections": null,
        "sectionInfos": null,
        "mirrorSections": null,
        "links": null,
        "rootChannels": null,
        "appliedPageLayouts": null,
        "hierarchyMirrorAcOpt": null,
        "hierarchyMirrorMetadataOpt": null,
        "children": null,
        "contentTypeScopes": null,
        "cloneSource": null,
        "sectionPaths": null,
        "sortLock": null,
        "parent": null,
        "mirrors": null,
        "root": null,
        "shown": null,
        "nextSequence": null,
        "entityID": null,
        "childOfMirrored": null,
        "metadataOption": null,
        "workflowID": null,
        "childOfMirror": null,
        "workflowName": null,
        "workflow": null,
        "channelRoot": null,
        "languages": null,
        "channels": null,
        "pathMembers": null,
        "sectionSortMethod": null,
        "contentSortMethod": null,
        "contentsAndSequences": null,
        "parentWorkflowID": null,
        "inheritedPageLayouts": null,
        "currentOrInheritedWorkflow": null,
        "contentNextSequence": null,
        "accessControlOption": null,
        "parentID": null,
        "mirror": null,
        "allNames": null,
        "languageCount": null,
        "mirrorSource": null,
        "link": null,
        "mirrorSourceID": null
      }
    ],
    "lastModified": "string",
    "media": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<language>string</language>
<sections>
  <id/>
  <level/>
  <status/>
  <printSequence/>
  <formSection/>
  <archived/>
  <users/>
  <viewUsers/>
  <groups/>
  <viewGroups/>
  <contentSections/>
  <sectionInfos/>
  <mirrorSections/>
  <links/>
  <rootChannels/>
  <appliedPageLayouts/>
  <hierarchyMirrorAcOpt/>
  <hierarchyMirrorMetadataOpt/>
  <children/>
  <contentTypeScopes/>
  <cloneSource/>
  <sectionPaths/>
  <sortLock/>
  <parent/>
  <mirrors/>
  <root/>
  <shown/>
  <nextSequence/>
  <entityID/>
  <childOfMirrored/>
  <metadataOption/>
  <workflowID/>
  <childOfMirror/>
  <workflowName/>
  <workflow/>
  <channelRoot/>
  <languages/>
  <channels/>
  <pathMembers/>
  <sectionSortMethod/>
  <contentSortMethod/>
  <contentsAndSequences/>
  <parentWorkflowID/>
  <inheritedPageLayouts/>
  <currentOrInheritedWorkflow/>
  <contentNextSequence/>
  <accessControlOption/>
  <parentID/>
  <mirror/>
  <allNames/>
  <languageCount/>
  <mirrorSource/>
  <link/>
  <mirrorSourceID/>
</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
»»»»»»»» channelIDs [integer] false none none
»»»»»»»» sectionIDs [integer] false none none
»»»»»»»» languageCount integer(int32) false none none
»»»»»»» mediaTypesWithPublishRuleCategory [integer] false none none
»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»» personalisationEnabled boolean false none none
»»»»»»» accessControlEnabled boolean false none none
»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»» parentID integer(int32) false none none
»»»»»»» contentIDs [integer] false none none
»»»»»»» languageCodes [string] false none none
»»»»»»» microSite boolean false none none
»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»» alias string false none none
»»»»»»»» directEditEnabled boolean false none none
»»»» deleted boolean false none none
»»»» memberCount integer(int32) false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
»»»»» value string false none none
»»»»» language string false none none
»»»»» sectionID integer(int32) false none none
»»»»» metaTagName string false none none
»»»»» metaTagID 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

Name In Type Required Description
languageCode path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "contentTypeId": 0,
    "language": "string",
    "version": "string",
    "name": "string",
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "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": null,
        "level": null,
        "status": null,
        "printSequence": null,
        "formSection": null,
        "archived": null,
        "users": null,
        "viewUsers": null,
        "groups": null,
        "viewGroups": null,
        "contentSections": null,
        "sectionInfos": null,
        "mirrorSections": null,
        "links": null,
        "rootChannels": null,
        "appliedPageLayouts": null,
        "hierarchyMirrorAcOpt": null,
        "hierarchyMirrorMetadataOpt": null,
        "children": null,
        "contentTypeScopes": null,
        "cloneSource": null,
        "sectionPaths": null,
        "sortLock": null,
        "parent": null,
        "mirrors": null,
        "root": null,
        "shown": null,
        "nextSequence": null,
        "entityID": null,
        "childOfMirrored": null,
        "metadataOption": null,
        "workflowID": null,
        "childOfMirror": null,
        "workflowName": null,
        "workflow": null,
        "channelRoot": null,
        "languages": null,
        "channels": null,
        "pathMembers": null,
        "sectionSortMethod": null,
        "contentSortMethod": null,
        "contentsAndSequences": null,
        "parentWorkflowID": null,
        "inheritedPageLayouts": null,
        "currentOrInheritedWorkflow": null,
        "contentNextSequence": null,
        "accessControlOption": null,
        "parentID": null,
        "mirror": null,
        "allNames": null,
        "languageCount": null,
        "mirrorSource": null,
        "link": null,
        "mirrorSourceID": null
      }
    ],
    "alreadyVoted": true,
    "hasAccessToContent": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<contentTypeId>0</contentTypeId>
<language>string</language>
<version>string</version>
<name>string</name>
<status>0</status>
<lastModified>2019-08-24T14:15:22Z</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/>
  <level/>
  <status/>
  <printSequence/>
  <formSection/>
  <archived/>
  <users/>
  <viewUsers/>
  <groups/>
  <viewGroups/>
  <contentSections/>
  <sectionInfos/>
  <mirrorSections/>
  <links/>
  <rootChannels/>
  <appliedPageLayouts/>
  <hierarchyMirrorAcOpt/>
  <hierarchyMirrorMetadataOpt/>
  <children/>
  <contentTypeScopes/>
  <cloneSource/>
  <sectionPaths/>
  <sortLock/>
  <parent/>
  <mirrors/>
  <root/>
  <shown/>
  <nextSequence/>
  <entityID/>
  <childOfMirrored/>
  <metadataOption/>
  <workflowID/>
  <childOfMirror/>
  <workflowName/>
  <workflow/>
  <channelRoot/>
  <languages/>
  <channels/>
  <pathMembers/>
  <sectionSortMethod/>
  <contentSortMethod/>
  <contentsAndSequences/>
  <parentWorkflowID/>
  <inheritedPageLayouts/>
  <currentOrInheritedWorkflow/>
  <contentNextSequence/>
  <accessControlOption/>
  <parentID/>
  <mirror/>
  <allNames/>
  <languageCount/>
  <mirrorSource/>
  <link/>
  <mirrorSourceID/>
</sections>
<alreadyVoted>true</alreadyVoted>
<hasAccessToContent>true</hasAccessToContent>

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
»»»»»»»» channelIDs [integer] false none none
»»»»»»»» sectionIDs [integer] false none none
»»»»»»»» languageCount integer(int32) false none none
»»»»»»» mediaTypesWithPublishRuleCategory [integer] false none none
»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»» personalisationEnabled boolean false none none
»»»»»»» accessControlEnabled boolean false none none
»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»» parentID integer(int32) false none none
»»»»»»» contentIDs [integer] false none none
»»»»»»» languageCodes [string] false none none
»»»»»»» microSite boolean false none none
»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»» alias string false none none
»»»»»»»» directEditEnabled boolean false none none
»»»» deleted boolean false none none
»»»» memberCount integer(int32) false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
»»»»» value string false none none
»»»»» language string false none none
»»»»» sectionID integer(int32) false none none
»»»»» metaTagName string false none none
»»»»» metaTagID 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
» hasAccessToContent 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

Name 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

Name In Type Required Description
section path integer(int32) true none
id path integer(int32) true none
language path string true none
prepareForEditor query boolean false none

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

Name 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

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

Example responses

200 Response

[
  {
    "id": 0,
    "contentTypeId": 0,
    "language": "string",
    "version": "string",
    "name": "string",
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "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": null,
        "level": null,
        "status": null,
        "printSequence": null,
        "formSection": null,
        "archived": null,
        "users": null,
        "viewUsers": null,
        "groups": null,
        "viewGroups": null,
        "contentSections": null,
        "sectionInfos": null,
        "mirrorSections": null,
        "links": null,
        "rootChannels": null,
        "appliedPageLayouts": null,
        "hierarchyMirrorAcOpt": null,
        "hierarchyMirrorMetadataOpt": null,
        "children": null,
        "contentTypeScopes": null,
        "cloneSource": null,
        "sectionPaths": null,
        "sortLock": null,
        "parent": null,
        "mirrors": null,
        "root": null,
        "shown": null,
        "nextSequence": null,
        "entityID": null,
        "childOfMirrored": null,
        "metadataOption": null,
        "workflowID": null,
        "childOfMirror": null,
        "workflowName": null,
        "workflow": null,
        "channelRoot": null,
        "languages": null,
        "channels": null,
        "pathMembers": null,
        "sectionSortMethod": null,
        "contentSortMethod": null,
        "contentsAndSequences": null,
        "parentWorkflowID": null,
        "inheritedPageLayouts": null,
        "currentOrInheritedWorkflow": null,
        "contentNextSequence": null,
        "accessControlOption": null,
        "parentID": null,
        "mirror": null,
        "allNames": null,
        "languageCount": null,
        "mirrorSource": null,
        "link": null,
        "mirrorSourceID": null
      }
    ],
    "alreadyVoted": true,
    "hasAccessToContent": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<contentTypeId>0</contentTypeId>
<language>string</language>
<version>string</version>
<name>string</name>
<status>0</status>
<lastModified>2019-08-24T14:15:22Z</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/>
  <level/>
  <status/>
  <printSequence/>
  <formSection/>
  <archived/>
  <users/>
  <viewUsers/>
  <groups/>
  <viewGroups/>
  <contentSections/>
  <sectionInfos/>
  <mirrorSections/>
  <links/>
  <rootChannels/>
  <appliedPageLayouts/>
  <hierarchyMirrorAcOpt/>
  <hierarchyMirrorMetadataOpt/>
  <children/>
  <contentTypeScopes/>
  <cloneSource/>
  <sectionPaths/>
  <sortLock/>
  <parent/>
  <mirrors/>
  <root/>
  <shown/>
  <nextSequence/>
  <entityID/>
  <childOfMirrored/>
  <metadataOption/>
  <workflowID/>
  <childOfMirror/>
  <workflowName/>
  <workflow/>
  <channelRoot/>
  <languages/>
  <channels/>
  <pathMembers/>
  <sectionSortMethod/>
  <contentSortMethod/>
  <contentsAndSequences/>
  <parentWorkflowID/>
  <inheritedPageLayouts/>
  <currentOrInheritedWorkflow/>
  <contentNextSequence/>
  <accessControlOption/>
  <parentID/>
  <mirror/>
  <allNames/>
  <languageCount/>
  <mirrorSource/>
  <link/>
  <mirrorSourceID/>
</sections>
<alreadyVoted>true</alreadyVoted>
<hasAccessToContent>true</hasAccessToContent>

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
»»»»»»»» channelIDs [integer] false none none
»»»»»»»» sectionIDs [integer] false none none
»»»»»»»» languageCount integer(int32) false none none
»»»»»»» mediaTypesWithPublishRuleCategory [integer] false none none
»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»» personalisationEnabled boolean false none none
»»»»»»» accessControlEnabled boolean false none none
»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»» parentID integer(int32) false none none
»»»»»»» contentIDs [integer] false none none
»»»»»»» languageCodes [string] false none none
»»»»»»» microSite boolean false none none
»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»» alias string false none none
»»»»»»»» directEditEnabled boolean false none none
»»»» deleted boolean false none none
»»»» memberCount integer(int32) false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
»»»»» value string false none none
»»»»» language string false none none
»»»»» sectionID integer(int32) false none none
»»»»» metaTagName string false none none
»»»»» metaTagID 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
» hasAccessToContent boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

getWithoutSection

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

Parameters

Name 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-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

Name 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

POST /content/{language}/getInAllLang

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "language": "string",
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<language>string</language>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

modify

POST /content/{section}/{id}/{language}

Parameters

Name In Type Required Description
section path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

delete

DELETE /content/{section}/{id}/{language}

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
force query boolean false none

Responses

Status Meaning Description Schema
default Default successful operation None

previewExisting

POST /content/{section}/{id}/{language}/preview

Parameters

Name In Type Required Description
section path integer(int32) true none

Example responses

200 Response

0

Responses

Status Meaning Description Schema
200 OK successful operation integer

getWithSection

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

Parameters

Name 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-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

add

POST /content/{section}/{language}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

previewNew

POST /content/{section}/{language}/preview

Parameters

Name In Type Required Description
section path integer(int32) true none

Example responses

200 Response

0

Responses

Status Meaning Description Schema
200 OK successful operation integer

contentHierarchy

These endpoints describe operations relating to calculating the section paths for a section a piece of content exists in.

getAllSectionPaths

POST /contentHierarchy/paths

Body parameter

[
  {
    "property1": {},
    "property2": {}
  }
]

Parameters

Name In Type Required Description
body body array[object] false none

Example responses

200 Response

{
  "property1": [
    "string"
  ],
  "property2": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>string</property1>
<property2>string</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties [string] false none none

getSectionPaths

GET /contentHierarchy/paths/{section}/{id}/{language}

Parameters

Name 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

{
  "property1": "string",
  "property2": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>string</property1>
<property2>string</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties string false none none

contenttype

These endpoints describe operations around Content Types within the TERMINALFOUR system.

list

GET /contenttype/type/{type}

Parameters

Name In Type Required Description
type path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {
        "id": null,
        "contentTypeID": null,
        "name": null,
        "description": null,
        "type": null,
        "maxSize": null,
        "compulsory": null,
        "input_method": null,
        "listId": null,
        "sequence": null,
        "alias": null,
        "contentTypeMetaInformation": null,
        "binary": null
      }
    ],
    "metaMapped": true,
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-08-24T14:15:22Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true,
      "language": "string"
    },
    "fullyAccessible": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<type>0</type>
<editable>true</editable>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</sharedGroups>
<alias>string</alias>
<workflow>0</workflow>
<systemTemplate>true</systemTemplate>
<sharedGroupCount>0</sharedGroupCount>
<contentTypeElements>
  <id/>
  <contentTypeID/>
  <name/>
  <description/>
  <type/>
  <maxSize/>
  <compulsory/>
  <input_method/>
  <listId/>
  <sequence/>
  <alias/>
  <contentTypeMetaInformation/>
  <binary/>
</contentTypeElements>
<metaMapped>true</metaMapped>
<lock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</lock>
<fullyAccessible>true</fullyAccessible>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ContentTypeMetaDataDTO] false none none
» sharedGroups [AssetSharingInformation] false none none
» metaMapped boolean false none none

add

POST /contenttype

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": 0,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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": {},
      "binary": true
    }
  ],
  "metaMapped": true,
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "minAuthLevel": 0,
  "enableDirectEdit": true,
  "elementIdforFilename": 0,
  "warningMessage": "string",
  "sectionId": 0,
  "duplicate": true,
  "duplicatedFromId": 0,
  "fullyAccessible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<contentType>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <type>0</type>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </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/>
    <binary>true</binary>
  </contentTypeElements>
  <metaMapped>true</metaMapped>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </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>

Responses

Status Meaning Description Schema
200 OK successful operation ContentTypeDTO

getSearchMetaData

GET /contenttype/report

Example responses

200 Response

[
  {
    "id": 0,
    "alias": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<alias>string</alias>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

listRestricted

GET /contenttype/restricted

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {
        "id": null,
        "contentTypeID": null,
        "name": null,
        "description": null,
        "type": null,
        "maxSize": null,
        "compulsory": null,
        "input_method": null,
        "listId": null,
        "sequence": null,
        "alias": null,
        "contentTypeMetaInformation": null,
        "binary": null
      }
    ],
    "metaMapped": true,
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-08-24T14:15:22Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true,
      "language": "string"
    },
    "fullyAccessible": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<type>0</type>
<editable>true</editable>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</sharedGroups>
<alias>string</alias>
<workflow>0</workflow>
<systemTemplate>true</systemTemplate>
<sharedGroupCount>0</sharedGroupCount>
<contentTypeElements>
  <id/>
  <contentTypeID/>
  <name/>
  <description/>
  <type/>
  <maxSize/>
  <compulsory/>
  <input_method/>
  <listId/>
  <sequence/>
  <alias/>
  <contentTypeMetaInformation/>
  <binary/>
</contentTypeElements>
<metaMapped>true</metaMapped>
<lock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</lock>
<fullyAccessible>true</fullyAccessible>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ContentTypeMetaDataDTO] false none none
» sharedGroups [AssetSharingInformation] false none none
» metaMapped boolean false none none

get

GET /contenttype/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": 0,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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": {},
      "binary": true
    }
  ],
  "metaMapped": true,
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "minAuthLevel": 0,
  "enableDirectEdit": true,
  "elementIdforFilename": 0,
  "warningMessage": "string",
  "sectionId": 0,
  "duplicate": true,
  "duplicatedFromId": 0,
  "fullyAccessible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<contentType>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <type>0</type>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </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/>
    <binary>true</binary>
  </contentTypeElements>
  <metaMapped>true</metaMapped>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </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>

Responses

Status Meaning Description Schema
200 OK successful operation ContentTypeDTO

modify

PUT /contenttype/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /contenttype/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getSharingInformation

GET /contenttype/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

modifySharingInformation

PUT /contenttype/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

contentTypeReport

These endpoints describe web service operations on the ContentType search report.

createReport

POST /contentTypeReport

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

downloadReport

GET /contentTypeReport/download/{id}

Parameters

Name In Type Required Description
id path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /contentTypeReport/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPage>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPage>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPage

dataobject

These endpoints describe operations around the data object broker in the TEMRINALFOUR system.

listDataObjects

GET /dataobject

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "contentTypes": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<username>string</username>
<password>string</password>
<contentTypes>string</contentTypes>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /dataobject

Responses

Status Meaning Description Schema
default Default successful operation None

getDataObject

GET /dataobject/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "username": "string",
  "password": "string",
  "contentTypes": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<DataObject>
  <id>0</id>
  <name>string</name>
  <username>string</username>
  <password>string</password>
  <contentTypes>string</contentTypes>
</DataObject>

Responses

Status Meaning Description Schema
200 OK successful operation DataObject

modify

PUT /dataobject/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /dataobject/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

datasource

These endpoints describe operations on external data sources within the TERMINALFOUR system.

listDataSources

GET /datasource

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "url": "string",
    "driver": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<username>string</username>
<password>string</password>
<url>string</url>
<driver>string</driver>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /datasource

Responses

Status Meaning Description Schema
default Default successful operation None

getDataSource

GET /datasource/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "username": "string",
  "password": "string",
  "url": "string",
  "driver": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceDTO>
  <id>0</id>
  <name>string</name>
  <username>string</username>
  <password>string</password>
  <url>string</url>
  <driver>string</driver>
</DataSourceDTO>

Responses

Status Meaning Description Schema
200 OK successful operation DataSourceDTO

modify

PUT /datasource/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /datasource/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getDataSourceMetaData

GET /datasource/{id}/metadata

Parameters

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

Example responses

200 Response

{
  "dataSourceName": "string",
  "tablesMetaData": [
    {
      "name": "string",
      "required": true,
      "primaryKey": [
        null
      ],
      "columnCount": 0,
      "columns": [
        null
      ]
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceMetaData>
  <dataSourceName>string</dataSourceName>
  <tablesMetaData>
    <name>string</name>
    <required>true</required>
    <primaryKey/>
    <columnCount>0</columnCount>
    <columns/>
  </tablesMetaData>
</DataSourceMetaData>

Responses

Status Meaning Description Schema
200 OK successful operation DataSourceMetaData

test

GET /datasource/{id}/test

Parameters

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

Example responses

200 Response

{
  "success": true,
  "message": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceTestResult>
  <success>true</success>
  <message>string</message>
</DataSourceTestResult>

Responses

Status Meaning Description Schema
200 OK successful operation DataSourceTestResult

datastore

These endpoints describe operations on data stores within the TERMINALFOUR system.

list

GET /datastore

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "databaseName": "string",
    "template": 0,
    "rootSection": 0,
    "archiveSection": 0,
    "contentStatus": 0,
    "tableName": "string",
    "query": "string",
    "channel": {
      "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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    },
    "language": {
      "code": "string",
      "name": "string",
      "charset": "string",
      "disclaimer": "string",
      "channels": [
        null
      ]
    },
    "dataStoreMappings": [
      {
        "id": null,
        "columnName": null,
        "link": null
      }
    ],
    "dataStoreContents": [
      {
        "id": null,
        "hash": null,
        "linkValue": null,
        "dataStore": null,
        "contentID": null
      }
    ],
    "dataSource": {
      "id": 0,
      "name": "string",
      "username": "string",
      "password": "string",
      "url": "string",
      "driver": "string",
      "dataStores": [
        null
      ]
    },
    "siteStructure": {
      "id": 0,
      "name": "string",
      "plugin": "string"
    },
    "endPointProperties": "string",
    "individualSections": true,
    "individualEvents": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<databaseName>string</databaseName>
<template>0</template>
<rootSection>0</rootSection>
<archiveSection>0</archiveSection>
<contentStatus>0</contentStatus>
<tableName>string</tableName>
<query>string</query>
<channel>
  <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>
  <pxlFolder>string</pxlFolder>
  <languages/>
  <microSites/>
  <permittedFileExtensions/>
  <translationDisclaimers/>
  <mediaPublishRules/>
  <channelFullTextDisplayPeriod/>
  <channelUsers/>
  <channelContents/>
  <mediaTypesWithPublishRuleCategory/>
  <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
  <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
  <channelCleanupEnabled>true</channelCleanupEnabled>
  <personalisationEnabled>true</personalisationEnabled>
  <accessControlEnabled>true</accessControlEnabled>
  <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
  <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
  <secondaryPublishEnabled>true</secondaryPublishEnabled>
  <overrideExtensionEnabled>true</overrideExtensionEnabled>
  <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
  <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
  <parentID>0</parentID>
  <contentIDs/>
  <languageCodes/>
  <microSite>true</microSite>
</channel>
<language>
  <code>string</code>
  <name>string</name>
  <charset>string</charset>
  <disclaimer>string</disclaimer>
  <channels/>
</language>
<dataStoreMappings>
  <id/>
  <columnName/>
  <link/>
</dataStoreMappings>
<dataStoreContents>
  <id/>
  <hash/>
  <linkValue/>
  <dataStore/>
  <contentID/>
</dataStoreContents>
<dataSource>
  <id>0</id>
  <name>string</name>
  <username>string</username>
  <password>string</password>
  <url>string</url>
  <driver>string</driver>
  <dataStores/>
</dataSource>
<siteStructure>
  <id>0</id>
  <name>string</name>
  <plugin>string</plugin>
</siteStructure>
<endPointProperties>string</endPointProperties>
<individualSections>true</individualSections>
<individualEvents>true</individualEvents>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DataStore] false none none
»»» priority integer(int32) false none none
»»» disclaimer string false none none
»»» publishRule integer(int32) false none none
»»»»»»» languageCount integer(int32) false none none
»»»»»» printSequence integer(int32) false none none
»»»»»» sortLock string false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» entityID integer(int32) false none none
»»»»»» contentID integer(int32) false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» pageLayoutID integer(int32) false none none
»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»» elementForFilename integer(int32) false none none
»»»»»»» alias string false none none
»»»»»»» directEditEnabled boolean false none none
»»»»»»»»» sequence integer(int32) false none none
»»»»»»»» restricted boolean false none none
»»»»»»» duplicate boolean false none none
»»»»»»» type integer(int32) false none none
»»»»»»» sectionID integer(int32) false none none
»»»»»»» minAuthLevel integer(int32) false none none
»»»»»» scope integer(int32) false none none
»»»»»» contentTypeID integer(int32) false none none
»»»»» sortLock string false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
»» columnName string false none none
»» link string false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

add

POST /datastore

Responses

Status Meaning Description Schema
default Default successful operation None

getRestServiceMetaData

POST /datastore/webservice/metadata

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

get

GET /datastore/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "template": 0,
  "rootSection": 0,
  "dataSourceID": 0,
  "siteStructureID": 0,
  "individualSections": true,
  "archiveSection": 0,
  "contentStatus": 0,
  "tableName": "string",
  "query": "string",
  "individualEvents": true,
  "channelID": 0,
  "languageCode": "string",
  "dataStoreMappings": [
    {
      "dataStoreID": 0,
      "elementName": "string",
      "columnName": "string",
      "link": "string"
    }
  ],
  "endPointProperties": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<DataStoreDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <template>0</template>
  <rootSection>0</rootSection>
  <dataSourceID>0</dataSourceID>
  <siteStructureID>0</siteStructureID>
  <individualSections>true</individualSections>
  <archiveSection>0</archiveSection>
  <contentStatus>0</contentStatus>
  <tableName>string</tableName>
  <query>string</query>
  <individualEvents>true</individualEvents>
  <channelID>0</channelID>
  <languageCode>string</languageCode>
  <dataStoreMappings>
    <dataStoreID>0</dataStoreID>
    <elementName>string</elementName>
    <columnName>string</columnName>
    <link>string</link>
  </dataStoreMappings>
  <endPointProperties>string</endPointProperties>
</DataStoreDTO>

Responses

Status Meaning Description Schema
200 OK successful operation DataStoreDTO

modify

PUT /datastore/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /datastore/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

directedit

These endpoints describe web service operations for the TERMINALFOUR Direct Edit service.

analytics

POST /directedit/analytics

Example responses

200 Response

{
  "totalUnique": [
    {
      "date": "2019-08-24T14:15:22Z",
      "total": 0,
      "unique": 0,
      "dateString": "string"
    }
  ],
  "pageViewsThisMonth": 0,
  "bounceRateThisMonth": 0,
  "averageTimeThisMonth": 0,
  "mostVisitsFromCountryThisMonth": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<DirectEditAnalyticsDTO>
  <totalUnique>
    <date>2019-08-24T14:15:22Z</date>
    <total>0</total>
    <unique>0</unique>
    <dateString>string</dateString>
  </totalUnique>
  <pageViewsThisMonth>0</pageViewsThisMonth>
  <bounceRateThisMonth>0</bounceRateThisMonth>
  <averageTimeThisMonth>0</averageTimeThisMonth>
  <mostVisitsFromCountryThisMonth>string</mostVisitsFromCountryThisMonth>
</DirectEditAnalyticsDTO>

Responses

Status Meaning Description Schema
200 OK successful operation DirectEditAnalyticsDTO

checkPublishURLAvailability

POST /directedit/checkurl

Example responses

200 Response

{
  "publishUrl": "string",
  "publishUrlExists": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<DirectEditPublishUrlAvailability>
  <publishUrl>string</publishUrl>
  <publishUrlExists>true</publishUrlExists>
</DirectEditPublishUrlAvailability>

Responses

Status Meaning Description Schema
200 OK successful operation DirectEditPublishUrlAvailability

directEditPage

GET /directedit/{channel}/{language}/{section}

Parameters

Name In Type Required Description
channel path integer(int32) true none
language path string true none
section path integer(int32) true none

Example responses

200 Response

{
  "channel": 0,
  "id": 0,
  "language": "string",
  "header": "string",
  "content": [
    {
      "id": 0,
      "name": "string",
      "contentTypeID": 0,
      "language": "string",
      "content": "string",
      "layout": "string",
      "version": "string",
      "status": 0,
      "sortOrder": 0,
      "directEditEnabled": true,
      "sortLock": "[",
      "lock": {},
      "future": true,
      "editable": true
    }
  ],
  "footer": "string",
  "paths": [
    "string"
  ],
  "editable": true,
  "publishUrl": "string",
  "userScriptsAllowed": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<DirectEditPagePreviewDTO>
  <channel>0</channel>
  <id>0</id>
  <language>string</language>
  <header>string</header>
  <content>
    <id>0</id>
    <name>string</name>
    <contentTypeID>0</contentTypeID>
    <language>string</language>
    <content>string</content>
    <layout>string</layout>
    <version>string</version>
    <status>0</status>
    <sortOrder>0</sortOrder>
    <directEditEnabled>true</directEditEnabled>
    <sortLock>[</sortLock>
    <lock/>
    <future>true</future>
    <editable>true</editable>
  </content>
  <footer>string</footer>
  <paths>string</paths>
  <editable>true</editable>
  <publishUrl>string</publishUrl>
  <userScriptsAllowed>true</userScriptsAllowed>
</DirectEditPagePreviewDTO>

Responses

Status Meaning Description Schema
200 OK successful operation DirectEditPagePreviewDTO

directEditMedia

GET /directedit/{channel}/{language}/{section}/media/{content}/{layout}

Parameters

Name In Type Required Description
channel path integer(int32) true none
section path integer(int32) true none
language path string true none
content path integer(int32) true none
layout path string true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "contentTypeID": 0,
  "language": "string",
  "content": "string",
  "layout": "string",
  "version": "string",
  "status": 0,
  "sortOrder": 0,
  "directEditEnabled": true,
  "sortLock": "TOP",
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "future": true,
  "editable": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<ContentPreviewDTO>
  <id>0</id>
  <name>string</name>
  <contentTypeID>0</contentTypeID>
  <language>string</language>
  <content>string</content>
  <layout>string</layout>
  <version>string</version>
  <status>0</status>
  <sortOrder>0</sortOrder>
  <directEditEnabled>true</directEditEnabled>
  <sortLock>TOP</sortLock>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <future>true</future>
  <editable>true</editable>
</ContentPreviewDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ContentPreviewDTO

directEditContent

GET /directedit/{channel}/{language}/{section}/partial/{content}

Parameters

Name In Type Required Description
channel path integer(int32) true none
section path integer(int32) true none
language path string true none
content path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "contentTypeID": 0,
  "language": "string",
  "content": "string",
  "layout": "string",
  "version": "string",
  "status": 0,
  "sortOrder": 0,
  "directEditEnabled": true,
  "sortLock": "TOP",
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "future": true,
  "editable": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<ContentPreviewDTO>
  <id>0</id>
  <name>string</name>
  <contentTypeID>0</contentTypeID>
  <language>string</language>
  <content>string</content>
  <layout>string</layout>
  <version>string</version>
  <status>0</status>
  <sortOrder>0</sortOrder>
  <directEditEnabled>true</directEditEnabled>
  <sortLock>TOP</sortLock>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <future>true</future>
  <editable>true</editable>
</ContentPreviewDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ContentPreviewDTO

directEditFullPageContent

GET /directedit/{channel}/{language}/{section}/partial/{content}/{layout}

Parameters

Name In Type Required Description
channel path integer(int32) true none
section path integer(int32) true none
language path string true none
content path integer(int32) true none
layout path string true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "contentTypeID": 0,
  "language": "string",
  "content": "string",
  "layout": "string",
  "version": "string",
  "status": 0,
  "sortOrder": 0,
  "directEditEnabled": true,
  "sortLock": "TOP",
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "future": true,
  "editable": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<ContentPreviewDTO>
  <id>0</id>
  <name>string</name>
  <contentTypeID>0</contentTypeID>
  <language>string</language>
  <content>string</content>
  <layout>string</layout>
  <version>string</version>
  <status>0</status>
  <sortOrder>0</sortOrder>
  <directEditEnabled>true</directEditEnabled>
  <sortLock>TOP</sortLock>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <future>true</future>
  <editable>true</editable>
</ContentPreviewDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ContentPreviewDTO

directEditFulltextPage

GET /directedit/{channel}/{language}/{section}/{content}/{layout}

Parameters

Name In Type Required Description
channel path integer(int32) true none
language path string true none
section path integer(int32) true none
content path integer(int32) true none
layout path string true none

Example responses

200 Response

{
  "channel": 0,
  "id": 0,
  "language": "string",
  "header": "string",
  "content": [
    {
      "id": 0,
      "name": "string",
      "contentTypeID": 0,
      "language": "string",
      "content": "string",
      "layout": "string",
      "version": "string",
      "status": 0,
      "sortOrder": 0,
      "directEditEnabled": true,
      "sortLock": "[",
      "lock": {},
      "future": true,
      "editable": true
    }
  ],
  "footer": "string",
  "paths": [
    "string"
  ],
  "editable": true,
  "publishUrl": "string",
  "userScriptsAllowed": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<DirectEditPagePreviewDTO>
  <channel>0</channel>
  <id>0</id>
  <language>string</language>
  <header>string</header>
  <content>
    <id>0</id>
    <name>string</name>
    <contentTypeID>0</contentTypeID>
    <language>string</language>
    <content>string</content>
    <layout>string</layout>
    <version>string</version>
    <status>0</status>
    <sortOrder>0</sortOrder>
    <directEditEnabled>true</directEditEnabled>
    <sortLock>[</sortLock>
    <lock/>
    <future>true</future>
    <editable>true</editable>
  </content>
  <footer>string</footer>
  <paths>string</paths>
  <editable>true</editable>
  <publishUrl>string</publishUrl>
  <userScriptsAllowed>true</userScriptsAllowed>
</DirectEditPagePreviewDTO>

Responses

Status Meaning Description Schema
200 OK successful operation DirectEditPagePreviewDTO

download

These endpoints describe operations on the TERMINALFOUR download service.

getFileFromElement

GET /download/{contentID}/{language}/{element}

Parameters

Name In Type Required Description
contentID path integer(int32) true none
language path string true none
element path string true none

Example responses

200 Response

{
  "filename": "string",
  "file": "string",
  "mimeType": "string",
  "fileLocation": "string",
  "code": "string",
  "cleanUp": true,
  "contentID": 0,
  "language": "string",
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "element": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation FileDownload

getFileFromElementVersion

GET /download/{contentID}/{language}/{version}/{element}

Parameters

Name In Type Required Description
contentID path integer(int32) true none
language path string true none
version path string true none
element path string true none

Example responses

200 Response

{
  "filename": "string",
  "file": "string",
  "mimeType": "string",
  "fileLocation": "string",
  "code": "string",
  "cleanUp": true,
  "contentID": 0,
  "language": "string",
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "element": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation FileDownload

error

This endpoint describes operations relating to the error logs within the TERMINALFOUR system.

list

GET /error

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

extranet

These endpoints describe getting the extranet connection parameters to allow a user to connect to the TERMINALFOUR Community site.

getExtranetConnectionParams

GET /extranet/connectionParams

Example responses

200 Response

{
  "id": 0,
  "username": "string",
  "userType": 0,
  "emailAddress": "string",
  "firstName": "string",
  "lastName": "string",
  "licenseKeyHash": "string",
  "licenseOverContentLimit": "string",
  "localSmUrl": "string",
  "extranetAccess": "string",
  "mySupport": 0,
  "authToken": "string",
  "osArch": "string",
  "osName": "string",
  "osVersion": "string",
  "jvmVendor": "string",
  "jvmVersion": "string",
  "servletContainerName": "string",
  "servletSpecVersion": "string",
  "dbProductName": "string",
  "dbProductVersion": "string",
  "dbDriverName": "string",
  "dbDriverVersion": "string",
  "smVersion": "string",
  "documentCount": "string",
  "workflowCount": "string",
  "channelCount": "string",
  "templateCount": "string",
  "userCount": "string",
  "languageCount": "string",
  "language": "string",
  "hash": "string",
  "extranetConsent": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<extranetConnectionParams>
  <id>0</id>
  <username>string</username>
  <userType>0</userType>
  <emailAddress>string</emailAddress>
  <firstName>string</firstName>
  <lastName>string</lastName>
  <licenseKeyHash>string</licenseKeyHash>
  <licenseOverContentLimit>string</licenseOverContentLimit>
  <localSmUrl>string</localSmUrl>
  <extranetAccess>string</extranetAccess>
  <mySupport>0</mySupport>
  <authToken>string</authToken>
  <osArch>string</osArch>
  <osName>string</osName>
  <osVersion>string</osVersion>
  <jvmVendor>string</jvmVendor>
  <jvmVersion>string</jvmVersion>
  <servletContainerName>string</servletContainerName>
  <servletSpecVersion>string</servletSpecVersion>
  <dbProductName>string</dbProductName>
  <dbProductVersion>string</dbProductVersion>
  <dbDriverName>string</dbDriverName>
  <dbDriverVersion>string</dbDriverVersion>
  <smVersion>string</smVersion>
  <documentCount>string</documentCount>
  <workflowCount>string</workflowCount>
  <channelCount>string</channelCount>
  <templateCount>string</templateCount>
  <userCount>string</userCount>
  <languageCount>string</languageCount>
  <language>string</language>
  <hash>string</hash>
  <extranetConsent>true</extranetConsent>
</extranetConnectionParams>

Responses

Status Meaning Description Schema
200 OK successful operation ExtranetConnectionParams

fieldmappings

These end points describe web service operations on the mappings of Formbuilder fields.

setMappings

PUT /fieldmappings/{formID}

Parameters

Name In Type Required Description
formID path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "formId": 0,
    "contentTypeId": 0,
    "formFieldId": 0,
    "elementName": "string",
    "contentElementID": 0,
    "strict": true,
    "alias": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<formId>0</formId>
<contentTypeId>0</contentTypeId>
<formFieldId>0</formFieldId>
<elementName>string</elementName>
<contentElementID>0</contentElementID>
<strict>true</strict>
<alias>string</alias>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getMappings

GET /fieldmappings/{formID}

Parameters

Name In Type Required Description
formID path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "formId": 0,
    "contentTypeId": 0,
    "formFieldId": 0,
    "elementName": "string",
    "contentElementID": 0,
    "strict": true,
    "alias": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<formId>0</formId>
<contentTypeId>0</contentTypeId>
<formFieldId>0</formFieldId>
<elementName>string</elementName>
<contentElementID>0</contentElementID>
<strict>true</strict>
<alias>string</alias>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

fileExtension

These web service endpoints describe operations on the permitted file extensions in the TERMINALFOUR system.

list

GET /fileExtension

Example responses

200 Response

[
  {
    "name": "string",
    "description": "string",
    "extension": "string",
    "channelFileExtensions": [
      {
        "id": null,
        "priority": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<name>string</name>
<description>string</description>
<extension>string</extension>
<channelFileExtensions>
  <id/>
  <priority/>
</channelFileExtensions>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [FileExtension] false none none
»»»»» disclaimer string false none none
»»»»» publishRule integer(int32) false none none
»»»»»»»»» languageCount integer(int32) false none none
»»»»»»»» printSequence integer(int32) false none none
»»»»»»»» sortLock string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» entityID integer(int32) false none none
»»»»»»»» contentID integer(int32) false none none
»»»»»»»»»» value string false none none
»»»»»»»»»» language string false none none
»»»»»»»»»» sectionID integer(int32) false none none
»»»»»»»»»» metaTagName string false none none
»»»»»»»»»» metaTagID integer(int32) false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» pageLayoutID integer(int32) false none none
»»»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»»» alias string false none none
»»»»»»»»» directEditEnabled boolean false none none
»»»»»»»»»»» sequence integer(int32) false none none
»»»»»»»»»» restricted boolean false none none
»»»»»»»»» duplicate boolean false none none
»»»»»»»»» type integer(int32) false none none
»»»»»»»»» sectionID integer(int32) false none none
»»»»»»»»» minAuthLevel integer(int32) false none none
»»»»»»»» scope integer(int32) false none none
»»»»»»»» contentTypeID integer(int32) false none none
»»»»»»» sortLock string false none none
»»»»»» language string false none none
»»»»»» name string false none none
»»»»»» owner integer(int32) false none none
»»»»»» id integer(int32) false none none
»»»»» fullLocaleCode string false none none
»» priority integer(int32) false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

get

GET /fileExtension/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "name": "string",
  "description": "string",
  "extension": "string",
  "channelFileExtensions": [
    {
      "id": {},
      "priority": 0
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<fileExtension>
  <name>string</name>
  <description>string</description>
  <extension>string</extension>
  <channelFileExtensions>
    <id/>
    <priority>0</priority>
  </channelFileExtensions>
</fileExtension>

Responses

Status Meaning Description Schema
200 OK successful operation FileExtension

add

PUT /fileExtension/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "name": "string",
  "description": "string",
  "extension": "string",
  "channelFileExtensions": [
    {
      "id": {},
      "priority": 0
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<fileExtension>
  <name>string</name>
  <description>string</description>
  <extension>string</extension>
  <channelFileExtensions>
    <id/>
    <priority>0</priority>
  </channelFileExtensions>
</fileExtension>

Responses

Status Meaning Description Schema
200 OK successful operation FileExtension

delete

DELETE /fileExtension/{name}

Parameters

Name In Type Required Description
name path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

formbuilder

These endpoints describe the functionality for the Formbuilder in the TERMINALFOUR system.

getRecaptchaConfig

GET /formbuilder/config

Example responses

200 Response

{
  "id": 0,
  "siteKey": "string",
  "secretKey": "string",
  "enabled": true,
  "enforced": true,
  "customerId": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<RecaptchaConfig>
  <id>0</id>
  <siteKey>string</siteKey>
  <secretKey>string</secretKey>
  <enabled>true</enabled>
  <enforced>true</enforced>
  <customerId>0</customerId>
</RecaptchaConfig>

Responses

Status Meaning Description Schema
200 OK successful operation RecaptchaConfig

saveRecaptchaConfig

POST /formbuilder/config

Responses

Status Meaning Description Schema
default Default successful operation None

updateRecaptchaConfig

PUT /formbuilder/config

Responses

Status Meaning Description Schema
default Default successful operation None

getConnectionStatus

GET /formbuilder/connect

Example responses

200 Response

{
  "formBuilderURI": "string",
  "connected": true,
  "licenseHash": "string",
  "publicKey": "string",
  "customerName": "string",
  "customerId": 0,
  "hostname": "string",
  "connectionStatus": "NOT_CONNECTED"
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormBuilderConfigurationResponse>
  <formBuilderURI>string</formBuilderURI>
  <connected>true</connected>
  <licenseHash>string</licenseHash>
  <publicKey>string</publicKey>
  <customerName>string</customerName>
  <customerId>0</customerId>
  <hostname>string</hostname>
  <connectionStatus>NOT_CONNECTED</connectionStatus>
</FormBuilderConfigurationResponse>

Responses

Status Meaning Description Schema
200 OK successful operation FormBuilderConfigurationResponse

connect

POST /formbuilder/connect

Example responses

200 Response

{
  "formBuilderURI": "string",
  "connected": true,
  "licenseHash": "string",
  "publicKey": "string",
  "customerName": "string",
  "customerId": 0,
  "hostname": "string",
  "connectionStatus": "NOT_CONNECTED"
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormBuilderConfigurationResponse>
  <formBuilderURI>string</formBuilderURI>
  <connected>true</connected>
  <licenseHash>string</licenseHash>
  <publicKey>string</publicKey>
  <customerName>string</customerName>
  <customerId>0</customerId>
  <hostname>string</hostname>
  <connectionStatus>NOT_CONNECTED</connectionStatus>
</FormBuilderConfigurationResponse>

Responses

Status Meaning Description Schema
200 OK successful operation FormBuilderConfigurationResponse

deleteConnectionStatus

DELETE /formbuilder/connect

Example responses

200 Response

{
  "formBuilderURI": "string",
  "connected": true,
  "licenseHash": "string",
  "publicKey": "string",
  "customerName": "string",
  "customerId": 0,
  "hostname": "string",
  "connectionStatus": "NOT_CONNECTED"
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormBuilderConfigurationResponse>
  <formBuilderURI>string</formBuilderURI>
  <connected>true</connected>
  <licenseHash>string</licenseHash>
  <publicKey>string</publicKey>
  <customerName>string</customerName>
  <customerId>0</customerId>
  <hostname>string</hostname>
  <connectionStatus>NOT_CONNECTED</connectionStatus>
</FormBuilderConfigurationResponse>

Responses

Status Meaning Description Schema
200 OK successful operation FormBuilderConfigurationResponse

contentTypesForForms

GET /formbuilder/contenttypes

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "alias": "string",
    "contentTypeElements": [
      {
        "id": null,
        "name": null,
        "alias": null,
        "type": null,
        "listId": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<alias>string</alias>
<contentTypeElements>
  <id/>
  <name/>
  <alias/>
  <type/>
  <listId/>
</contentTypeElements>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

listsForForms

GET /formbuilder/lists/{language}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "language": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<language>string</language>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getRecaptchaConfiguration

GET /formbuilder/recaptchaStatus

Example responses

200 Response

{
  "enabled": true,
  "enforced": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<RecaptchaDTO>
  <enabled>true</enabled>
  <enforced>true</enforced>
</RecaptchaDTO>

Responses

Status Meaning Description Schema
200 OK successful operation RecaptchaDTO

list

POST /formbuilder/{language}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "submissionSectionId": 0,
      "restricted": true,
      "incompleteMappings": true,
      "usage": [
        null
      ]
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormDefinitions>
  <draw>0</draw>
  <recordsTotal>0</recordsTotal>
  <recordsFiltered>0</recordsFiltered>
  <data>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <submissionSectionId>0</submissionSectionId>
    <restricted>true</restricted>
    <incompleteMappings>true</incompleteMappings>
    <usage/>
  </data>
</FormDefinitions>

Responses

Status Meaning Description Schema
200 OK successful operation FormDefinitions

get

GET /formbuilder/{language}/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "showName": true,
  "showDescription": true,
  "includeCss": true,
  "usage": [
    {
      "formId": 0,
      "assetId": 0,
      "language": "string",
      "element": "string",
      "type": "string",
      "sectionId": 0,
      "name": "string"
    }
  ],
  "hasSubmissions": true,
  "embedUrl": "string",
  "shareUrl": "string",
  "formbankDomain": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormDefinition>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <showName>true</showName>
  <showDescription>true</showDescription>
  <includeCss>true</includeCss>
  <usage>
    <formId>0</formId>
    <assetId>0</assetId>
    <language>string</language>
    <element>string</element>
    <type>string</type>
    <sectionId>0</sectionId>
    <name>string</name>
  </usage>
  <hasSubmissions>true</hasSubmissions>
  <embedUrl>string</embedUrl>
  <shareUrl>string</shareUrl>
  <formbankDomain>string</formbankDomain>
</FormDefinition>

Responses

Status Meaning Description Schema
200 OK successful operation FormDefinition

modify

PUT /formbuilder/{language}/{id}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "showName": true,
  "showDescription": true,
  "includeCss": true,
  "usage": [
    {
      "formId": 0,
      "assetId": 0,
      "language": "string",
      "element": "string",
      "type": "string",
      "sectionId": 0,
      "name": "string"
    }
  ],
  "hasSubmissions": true,
  "embedUrl": "string",
  "shareUrl": "string",
  "formbankDomain": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormDefinition>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <showName>true</showName>
  <showDescription>true</showDescription>
  <includeCss>true</includeCss>
  <usage>
    <formId>0</formId>
    <assetId>0</assetId>
    <language>string</language>
    <element>string</element>
    <type>string</type>
    <sectionId>0</sectionId>
    <name>string</name>
  </usage>
  <hasSubmissions>true</hasSubmissions>
  <embedUrl>string</embedUrl>
  <shareUrl>string</shareUrl>
  <formbankDomain>string</formbankDomain>
</FormDefinition>

Responses

Status Meaning Description Schema
200 OK successful operation FormDefinition

delete

DELETE /formbuilder/{language}/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

listDependencies

GET /formbuilder/{language}/{id}/dependencies

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "index": 0,
    "formId": 0,
    "parentId": 0,
    "actionFieldId": 0,
    "actionType": "string",
    "actionValue": 0,
    "logicalOperator": "string",
    "conditions": [
      {
        "id": null,
        "formDependencyId": null,
        "formFieldId": null,
        "operator": null,
        "value": null,
        "logicalOperator": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<index>0</index>
<formId>0</formId>
<parentId>0</parentId>
<actionFieldId>0</actionFieldId>
<actionType>string</actionType>
<actionValue>0</actionValue>
<logicalOperator>string</logicalOperator>
<conditions>
  <id/>
  <formDependencyId/>
  <formFieldId/>
  <operator/>
  <value/>
  <logicalOperator/>
</conditions>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

updateDependencies

PUT /formbuilder/{language}/{id}/dependencies

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

listFields

GET /formbuilder/{language}/{id}/fields

Parameters

Name In Type Required Description
language path string true none
id 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

updateFields

POST /formbuilder/{language}/{id}/fields

Parameters

Name In Type Required Description
language path string true none
id 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

addFields

PUT /formbuilder/{language}/{id}/fields

Parameters

Name In Type Required Description
language path string true none
id 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

submissionSettings

GET /formbuilder/{language}/{id}/submissionSettings

Parameters

Name In Type Required Description
language path string true none
id 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

addSubmissionSettings

POST /formbuilder/{language}/{id}/submissionSettings

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

updateSubmissionSettings

PUT /formbuilder/{language}/{id}/submissionSettings

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

formsubmissionreport

These endpoints describe the web service operations around the Form submission reports.

deleteSubmissionContent

DELETE /formsubmissionreport/{language}

Parameters

Name In Type Required Description
language path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

rebuildSubmissionIndex

GET /formsubmissionreport/{language}/rebuild

Parameters

Name In Type Required Description
language path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

buildReport

GET /formsubmissionreport/{language}/{formID}/{start}/{end}

Parameters

Name In Type Required Description
formID path integer(int32) true none
start path string true none
end path string true none
language path string true none

Example responses

200 Response

{
  "id": 0,
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "formName": "string",
  "sectionID": 0,
  "graphLabels": [
    "string"
  ],
  "graphData": [
    0
  ],
  "columns": [
    {
      "id": 0,
      "type": "string",
      "label": "string"
    }
  ],
  "formReportData": [
    [
      {
        "data": null,
        "columnID": null,
        "columnType": null
      }
    ]
  ],
  "data": [
    [
      "string"
    ]
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormSubmissionReport>
  <id>0</id>
  <draw>0</draw>
  <recordsTotal>0</recordsTotal>
  <recordsFiltered>0</recordsFiltered>
  <formName>string</formName>
  <sectionID>0</sectionID>
  <graphLabels>string</graphLabels>
  <graphData>0</graphData>
  <columns>
    <id>0</id>
    <type>string</type>
    <label>string</label>
  </columns>
  <formReportData>
    <data/>
    <columnID/>
    <columnType/>
  </formReportData>
  <data>string</data>
</FormSubmissionReport>

Responses

Status Meaning Description Schema
200 OK successful operation FormSubmissionReport

buildReportDataForTable

POST /formsubmissionreport/{language}/{formID}/{start}/{end}

Parameters

Name In Type Required Description
formID path integer(int32) true none
start path string true none
end path string true none
language path string true none

Example responses

200 Response

{
  "id": 0,
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "formName": "string",
  "sectionID": 0,
  "graphLabels": [
    "string"
  ],
  "graphData": [
    0
  ],
  "columns": [
    {
      "id": 0,
      "type": "string",
      "label": "string"
    }
  ],
  "formReportData": [
    [
      {
        "data": null,
        "columnID": null,
        "columnType": null
      }
    ]
  ],
  "data": [
    [
      "string"
    ]
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<FormSubmissionReport>
  <id>0</id>
  <draw>0</draw>
  <recordsTotal>0</recordsTotal>
  <recordsFiltered>0</recordsFiltered>
  <formName>string</formName>
  <sectionID>0</sectionID>
  <graphLabels>string</graphLabels>
  <graphData>0</graphData>
  <columns>
    <id>0</id>
    <type>string</type>
    <label>string</label>
  </columns>
  <formReportData>
    <data/>
    <columnID/>
    <columnType/>
  </formReportData>
  <data>string</data>
</FormSubmissionReport>

Responses

Status Meaning Description Schema
200 OK successful operation FormSubmissionReport

downloadCSV

GET /formsubmissionreport/{language}/{formID}/{start}/{end}/csv

Parameters

Name In Type Required Description
formID path integer(int32) true none
start path string true none
end path string true none
language path string true none

Example responses

200 Response

{
  "filename": "string",
  "file": "string",
  "mimeType": "string",
  "fileLocation": "string",
  "code": "string",
  "cleanUp": true,
  "contentID": 0,
  "language": "string",
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "element": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<fileDownload>
  <filename>string</filename>
  <file>string</file>
  <mimeType>string</mimeType>
  <fileLocation>string</fileLocation>
  <code>string</code>
  <cleanUp>true</cleanUp>
  <contentID>0</contentID>
  <language>string</language>
  <version>
    <version>string</version>
    <subMinor>0</subMinor>
    <major>0</major>
    <minor>0</minor>
  </version>
  <element>string</element>
</fileDownload>

Responses

Status Meaning Description Schema
200 OK successful operation FileDownload

group

These endpoints describe operations around the Groups functionality in the TERMINALFOUR system.

list

GET /group

Parameters

Name In Type Required Description
pageNumber query integer(int32) false none
pageSize query integer(int32) false none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "membersCount": 0,
    "groupSections": [
      {
        "id": null,
        "path": null
      }
    ],
    "members": [
      {
        "id": null,
        "username": null,
        "firstName": null,
        "lastName": null,
        "authLevel": null,
        "emailAddress": null
      }
    ],
    "defaultPreviewChannel": 0,
    "emailAddress": "string",
    "children": [
      0
    ],
    "groupChildren": [
      {
        "id": null,
        "name": null,
        "description": null,
        "membersCount": null,
        "groupSections": null,
        "members": null,
        "defaultPreviewChannel": null,
        "emailAddress": null,
        "children": null,
        "groupChildren": null,
        "ldap": null,
        "groupEnabled": null
      }
    ],
    "ldap": true,
    "groupEnabled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<membersCount>0</membersCount>
<groupSections>
  <id/>
  <path/>
</groupSections>
<members>
  <id/>
  <username/>
  <firstName/>
  <lastName/>
  <authLevel/>
  <emailAddress/>
</members>
<defaultPreviewChannel>0</defaultPreviewChannel>
<emailAddress>string</emailAddress>
<children>0</children>
<groupChildren>
  <id/>
  <name/>
  <description/>
  <membersCount/>
  <groupSections/>
  <members/>
  <defaultPreviewChannel/>
  <emailAddress/>
  <children/>
  <groupChildren/>
  <ldap/>
  <groupEnabled/>
</groupChildren>
<ldap>true</ldap>
<groupEnabled>true</groupEnabled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /group

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "membersCount": 0,
  "groupSections": [
    {
      "id": 0,
      "path": "string"
    }
  ],
  "members": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "defaultPreviewChannel": 0,
  "emailAddress": "string",
  "children": [
    0
  ],
  "groupChildren": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "ldap": true,
  "groupEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<GroupMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <membersCount>0</membersCount>
  <groupSections>
    <id>0</id>
    <path>string</path>
  </groupSections>
  <members>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <authLevel>0</authLevel>
    <emailAddress>string</emailAddress>
  </members>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <emailAddress>string</emailAddress>
  <children>0</children>
  <groupChildren>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groupChildren>
  <ldap>true</ldap>
  <groupEnabled>true</groupEnabled>
</GroupMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation GroupMetaDataDTO

accessRights

GET /group/accessRights/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "membersCount": 0,
  "groupSections": [
    {
      "id": 0,
      "path": "string"
    }
  ],
  "members": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "defaultPreviewChannel": 0,
  "emailAddress": "string",
  "children": [
    0
  ],
  "groupChildren": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "ldap": true,
  "groupEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<GroupMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <membersCount>0</membersCount>
  <groupSections>
    <id>0</id>
    <path>string</path>
  </groupSections>
  <members>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <authLevel>0</authLevel>
    <emailAddress>string</emailAddress>
  </members>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <emailAddress>string</emailAddress>
  <children>0</children>
  <groupChildren>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groupChildren>
  <ldap>true</ldap>
  <groupEnabled>true</groupEnabled>
</GroupMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation GroupMetaDataDTO

listAllGroups

GET /group/allGroups

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "membersCount": 0,
    "groupSections": [
      {
        "id": null,
        "path": null
      }
    ],
    "members": [
      {
        "id": null,
        "username": null,
        "firstName": null,
        "lastName": null,
        "authLevel": null,
        "emailAddress": null
      }
    ],
    "defaultPreviewChannel": 0,
    "emailAddress": "string",
    "children": [
      0
    ],
    "groupChildren": [
      {
        "id": null,
        "name": null,
        "description": null,
        "membersCount": null,
        "groupSections": null,
        "members": null,
        "defaultPreviewChannel": null,
        "emailAddress": null,
        "children": null,
        "groupChildren": null,
        "ldap": null,
        "groupEnabled": null
      }
    ],
    "ldap": true,
    "groupEnabled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<membersCount>0</membersCount>
<groupSections>
  <id/>
  <path/>
</groupSections>
<members>
  <id/>
  <username/>
  <firstName/>
  <lastName/>
  <authLevel/>
  <emailAddress/>
</members>
<defaultPreviewChannel>0</defaultPreviewChannel>
<emailAddress>string</emailAddress>
<children>0</children>
<groupChildren>
  <id/>
  <name/>
  <description/>
  <membersCount/>
  <groupSections/>
  <members/>
  <defaultPreviewChannel/>
  <emailAddress/>
  <children/>
  <groupChildren/>
  <ldap/>
  <groupEnabled/>
</groupChildren>
<ldap>true</ldap>
<groupEnabled>true</groupEnabled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getGroupName

GET /group/groupName/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "membersCount": 0,
  "groupSections": [
    {
      "id": 0,
      "path": "string"
    }
  ],
  "members": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "defaultPreviewChannel": 0,
  "emailAddress": "string",
  "children": [
    0
  ],
  "groupChildren": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "ldap": true,
  "groupEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<GroupMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <membersCount>0</membersCount>
  <groupSections>
    <id>0</id>
    <path>string</path>
  </groupSections>
  <members>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <authLevel>0</authLevel>
    <emailAddress>string</emailAddress>
  </members>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <emailAddress>string</emailAddress>
  <children>0</children>
  <groupChildren>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groupChildren>
  <ldap>true</ldap>
  <groupEnabled>true</groupEnabled>
</GroupMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation GroupMetaDataDTO

getTopLevelGroups

GET /group/topLevelGroups

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "membersCount": 0,
    "groupSections": [
      {
        "id": null,
        "path": null
      }
    ],
    "members": [
      {
        "id": null,
        "username": null,
        "firstName": null,
        "lastName": null,
        "authLevel": null,
        "emailAddress": null
      }
    ],
    "defaultPreviewChannel": 0,
    "emailAddress": "string",
    "children": [
      0
    ],
    "groupChildren": [
      {
        "id": null,
        "name": null,
        "description": null,
        "membersCount": null,
        "groupSections": null,
        "members": null,
        "defaultPreviewChannel": null,
        "emailAddress": null,
        "children": null,
        "groupChildren": null,
        "ldap": null,
        "groupEnabled": null
      }
    ],
    "ldap": true,
    "groupEnabled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<membersCount>0</membersCount>
<groupSections>
  <id/>
  <path/>
</groupSections>
<members>
  <id/>
  <username/>
  <firstName/>
  <lastName/>
  <authLevel/>
  <emailAddress/>
</members>
<defaultPreviewChannel>0</defaultPreviewChannel>
<emailAddress>string</emailAddress>
<children>0</children>
<groupChildren>
  <id/>
  <name/>
  <description/>
  <membersCount/>
  <groupSections/>
  <members/>
  <defaultPreviewChannel/>
  <emailAddress/>
  <children/>
  <groupChildren/>
  <ldap/>
  <groupEnabled/>
</groupChildren>
<ldap>true</ldap>
<groupEnabled>true</groupEnabled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getUserGroups

GET /group/user/{id}

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "emailAddress": "string",
    "createDate": "2019-08-24T14:15:22Z",
    "enabled": true,
    "ldap": true,
    "defaultChannel": 0,
    "deleted": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<emailAddress>string</emailAddress>
<createDate>2019-08-24T14:15:22Z</createDate>
<enabled>true</enabled>
<ldap>true</ldap>
<defaultChannel>0</defaultChannel>
<deleted>true</deleted>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /group/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "membersCount": 0,
  "groupSections": [
    {
      "id": 0,
      "path": "string"
    }
  ],
  "members": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "defaultPreviewChannel": 0,
  "emailAddress": "string",
  "children": [
    0
  ],
  "groupChildren": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "ldap": true,
  "groupEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<GroupMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <membersCount>0</membersCount>
  <groupSections>
    <id>0</id>
    <path>string</path>
  </groupSections>
  <members>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <authLevel>0</authLevel>
    <emailAddress>string</emailAddress>
  </members>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <emailAddress>string</emailAddress>
  <children>0</children>
  <groupChildren>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groupChildren>
  <ldap>true</ldap>
  <groupEnabled>true</groupEnabled>
</GroupMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation GroupMetaDataDTO

update

PUT /group/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /group/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

groupSearch

These endpoints describe the operation of retrieving the group rights of the currently logged in user.

getCredentials

GET /groupSearch

Example responses

200 Response

{
  "groupsAllowed": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "defaultPreviewChannels": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ],
  "canDeleteGroupEnabled": true,
  "editSectionEnabled": true,
  "createNewGroupEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<GroupSearchCredentialsDTO>
  <groupsAllowed>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groupsAllowed>
  <defaultPreviewChannels>
    <id>0</id>
    <description>string</description>
    <name>string</name>
    <parentID>0</parentID>
    <fullName>string</fullName>
  </defaultPreviewChannels>
  <canDeleteGroupEnabled>true</canDeleteGroupEnabled>
  <editSectionEnabled>true</editSectionEnabled>
  <createNewGroupEnabled>true</createNewGroupEnabled>
</GroupSearchCredentialsDTO>

Responses

Status Meaning Description Schema
200 OK successful operation GroupSearchCredentialsDTO

hierarchy

These endpoints provide the functionality for the site structure hierarchy in the TERMINALFOUR system.

getChildByName

GET /hierarchy/child/{parent}/{name}/{language}

Parameters

Name In Type Required Description
parent path integer(int32) true none
name path string true none
language path string true none

Example responses

200 Response

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<SectionDTO>
  <id>0</id>
  <parent>0</parent>
  <name>string</name>
  <description>string</description>
  <outputUrl>string</outputUrl>
  <outputFilename>string</outputFilename>
  <accessKey>string</accessKey>
  <keyPhrase>string</keyPhrase>
  <status>0</status>
  <workflow>0</workflow>
  <parentWorkflowName>string</parentWorkflowName>
  <show>true</show>
  <iseForm>true</iseForm>
  <archive>true</archive>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <printSequence>0</printSequence>
  <contentSortMethod>0</contentSortMethod>
  <sectionSortMethod>0</sectionSortMethod>
  <path>string</path>
  <mirrorOf>0</mirrorOf>
  <sourceOfMirror>true</sourceOfMirror>
  <link>true</link>
  <channels>
    <id>0</id>
    <pageLayout>0</pageLayout>
    <inheritedPageLayout>0</inheritedPageLayout>
    <valid>true</valid>
  </channels>
  <userIDs>0</userIDs>
  <inheritedUserIDs>0</inheritedUserIDs>
  <groupIDs>0</groupIDs>
  <inheritedGroupIDs>0</inheritedGroupIDs>
  <viewUserIDs>0</viewUserIDs>
  <viewGroupIDs>0</viewGroupIDs>
  <contentTypeScopes>
    <id>0</id>
    <scope>0</scope>
    <inherited>true</inherited>
  </contentTypeScopes>
  <metaDatas>
    <id>0</id>
    <value>string</value>
    <lang>string</lang>
  </metaDatas>
  <linkInfo>
    <type>0</type>
    <section>0</section>
    <url>string</url>
    <language>string</language>
    <target>string</target>
    <accessControl>0</accessControl>
    <override>true</override>
    <overridden>true</overridden>
  </linkInfo>
  <excludedMirrorSections>0</excludedMirrorSections>
  <workflowName>string</workflowName>
  <parentWorkflowID>0</parentWorkflowID>
  <accessControl>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </accessControl>
  <metaData>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </metaData>
  <pathMembers>0</pathMembers>
  <sortLock>TOP</sortLock>
  <editable>true</editable>
  <inheritedLinkSection>true</inheritedLinkSection>
  <accessControlEnabled>true</accessControlEnabled>
  <accessControlType>0</accessControlType>
  <metaDataType>0</metaDataType>
  <accessControlInherited>true</accessControlInherited>
  <allowedGroups>0</allowedGroups>
  <mirrorOfPath>string</mirrorOfPath>
  <inheritedPageLayouts>
    <property1>0</property1>
    <property2>0</property2>
  </inheritedPageLayouts>
  <outputUriEnabled>true</outputUriEnabled>
  <publishEnabled>true</publishEnabled>
  <outputFilenameEnabled>true</outputFilenameEnabled>
  <spellCheckEnabled>true</spellCheckEnabled>
  <pathAsOutputUriEnabled>true</pathAsOutputUriEnabled>
</SectionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation SectionDTO

content

POST /hierarchy/content

Example responses

200 Response

{
  "id": 0,
  "contents": [
    {
      "id": 0,
      "name": "string",
      "status": "string",
      "lastModified": "string",
      "lastModifiedBy": "string",
      "expired": true
    }
  ],
  "path": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<section>
  <id>0</id>
  <contents>
    <id>0</id>
    <name>string</name>
    <status>string</status>
    <lastModified>string</lastModified>
    <lastModifiedBy>string</lastModifiedBy>
    <expired>true</expired>
  </contents>
  <path>string</path>
</section>

Responses

Status Meaning Description Schema
200 OK successful operation HierarchyContentResponseDTO

listInactive

GET /hierarchy/inactive/{languageCode}

Parameters

Name In Type Required Description
languageCode path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "path": "string",
    "mirroredSections": [
      "string"
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<path>string</path>
<mirroredSections>string</mirroredSections>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getDefaultOptions

GET /hierarchy/options/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<SectionDTO>
  <id>0</id>
  <parent>0</parent>
  <name>string</name>
  <description>string</description>
  <outputUrl>string</outputUrl>
  <outputFilename>string</outputFilename>
  <accessKey>string</accessKey>
  <keyPhrase>string</keyPhrase>
  <status>0</status>
  <workflow>0</workflow>
  <parentWorkflowName>string</parentWorkflowName>
  <show>true</show>
  <iseForm>true</iseForm>
  <archive>true</archive>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <printSequence>0</printSequence>
  <contentSortMethod>0</contentSortMethod>
  <sectionSortMethod>0</sectionSortMethod>
  <path>string</path>
  <mirrorOf>0</mirrorOf>
  <sourceOfMirror>true</sourceOfMirror>
  <link>true</link>
  <channels>
    <id>0</id>
    <pageLayout>0</pageLayout>
    <inheritedPageLayout>0</inheritedPageLayout>
    <valid>true</valid>
  </channels>
  <userIDs>0</userIDs>
  <inheritedUserIDs>0</inheritedUserIDs>
  <groupIDs>0</groupIDs>
  <inheritedGroupIDs>0</inheritedGroupIDs>
  <viewUserIDs>0</viewUserIDs>
  <viewGroupIDs>0</viewGroupIDs>
  <contentTypeScopes>
    <id>0</id>
    <scope>0</scope>
    <inherited>true</inherited>
  </contentTypeScopes>
  <metaDatas>
    <id>0</id>
    <value>string</value>
    <lang>string</lang>
  </metaDatas>
  <linkInfo>
    <type>0</type>
    <section>0</section>
    <url>string</url>
    <language>string</language>
    <target>string</target>
    <accessControl>0</accessControl>
    <override>true</override>
    <overridden>true</overridden>
  </linkInfo>
  <excludedMirrorSections>0</excludedMirrorSections>
  <workflowName>string</workflowName>
  <parentWorkflowID>0</parentWorkflowID>
  <accessControl>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </accessControl>
  <metaData>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </metaData>
  <pathMembers>0</pathMembers>
  <sortLock>TOP</sortLock>
  <editable>true</editable>
  <inheritedLinkSection>true</inheritedLinkSection>
  <accessControlEnabled>true</accessControlEnabled>
  <accessControlType>0</accessControlType>
  <metaDataType>0</metaDataType>
  <accessControlInherited>true</accessControlInherited>
  <allowedGroups>0</allowedGroups>
  <mirrorOfPath>string</mirrorOfPath>
  <inheritedPageLayouts>
    <property1>0</property1>
    <property2>0</property2>
  </inheritedPageLayouts>
  <outputUriEnabled>true</outputUriEnabled>
  <publishEnabled>true</publishEnabled>
  <outputFilenameEnabled>true</outputFilenameEnabled>
  <spellCheckEnabled>true</spellCheckEnabled>
  <pathAsOutputUriEnabled>true</pathAsOutputUriEnabled>
</SectionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation SectionDTO

propagateAccessControl

POST /hierarchy/propagate/{id}

Body parameter

{
  "addGroupIds": [
    0
  ],
  "removeGroupIds": [
    0
  ]
}

Parameters

Name In Type Required Description
id path integer(int32) true none
body body AccessControlPropagateDTO false none

Responses

Status Meaning Description Schema
default Default successful operation None

purge

POST /hierarchy/purge

Body parameter

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

Parameters

Name In Type Required Description
body body PurgeRequestDTO false none

Responses

Status Meaning Description Schema
default Default successful operation None

section

POST /hierarchy/section

Example responses

200 Response

[
  {
    "id": 0,
    "names": {
      "property1": "string",
      "property2": "string"
    },
    "hasChildren": true,
    "open": true,
    "getcountContentApproved": 0,
    "getcountContentPending": 0,
    "getcountContentInactive": 0,
    "visible": true,
    "archive": true,
    "seoCheckingResult": 0,
    "accessibilityCheckingResult": 0,
    "status": 0,
    "icon": "string",
    "mirrorType": "string",
    "subsections": [
      {
        "id": null,
        "names": null,
        "hasChildren": null,
        "open": null,
        "getcountContentApproved": null,
        "getcountContentPending": null,
        "getcountContentInactive": null,
        "visible": null,
        "archive": null,
        "seoCheckingResult": null,
        "accessibilityCheckingResult": null,
        "status": null,
        "icon": null,
        "mirrorType": null,
        "subsections": null,
        "link": null,
        "lastModified": null,
        "printSequence": null,
        "language": null,
        "showOptionsMenu": null,
        "path": null,
        "enablePublish": null,
        "allowUserModifySections": null,
        "name": null,
        "userAllowedModifySections": null,
        "publishEnabled": null
      }
    ],
    "link": true,
    "lastModified": "2019-08-24T14:15:22Z",
    "printSequence": 0,
    "language": "string",
    "showOptionsMenu": true,
    "path": "string",
    "enablePublish": true,
    "allowUserModifySections": true,
    "name": "string",
    "userAllowedModifySections": true,
    "publishEnabled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<names>
  <property1>string</property1>
  <property2>string</property2>
</names>
<hasChildren>true</hasChildren>
<open>true</open>
<getcountContentApproved>0</getcountContentApproved>
<getcountContentPending>0</getcountContentPending>
<getcountContentInactive>0</getcountContentInactive>
<visible>true</visible>
<archive>true</archive>
<seoCheckingResult>0</seoCheckingResult>
<accessibilityCheckingResult>0</accessibilityCheckingResult>
<status>0</status>
<icon>string</icon>
<mirrorType>string</mirrorType>
<subsections>
  <id/>
  <names/>
  <hasChildren/>
  <open/>
  <getcountContentApproved/>
  <getcountContentPending/>
  <getcountContentInactive/>
  <visible/>
  <archive/>
  <seoCheckingResult/>
  <accessibilityCheckingResult/>
  <status/>
  <icon/>
  <mirrorType/>
  <subsections/>
  <link/>
  <lastModified/>
  <printSequence/>
  <language/>
  <showOptionsMenu/>
  <path/>
  <enablePublish/>
  <allowUserModifySections/>
  <name/>
  <userAllowedModifySections/>
  <publishEnabled/>
</subsections>
<link>true</link>
<lastModified>2019-08-24T14:15:22Z</lastModified>
<printSequence>0</printSequence>
<language>string</language>
<showOptionsMenu>true</showOptionsMenu>
<path>string</path>
<enablePublish>true</enablePublish>
<allowUserModifySections>true</allowUserModifySections>
<name>string</name>
<userAllowedModifySections>true</userAllowedModifySections>
<publishEnabled>true</publishEnabled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

delete

DELETE /hierarchy/{id}

Parameters

Name In Type Required Description
id path integer(int32) true none
mandatory query boolean false none

Responses

Status Meaning Description Schema
default Default successful operation None

getContentTypes

GET /hierarchy/{id}/contenttype

Parameters

Name In Type Required Description
id path integer(int32) true none
directedit query boolean false none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {
        "id": null,
        "contentTypeID": null,
        "name": null,
        "description": null,
        "type": null,
        "maxSize": null,
        "compulsory": null,
        "input_method": null,
        "listId": null,
        "sequence": null,
        "alias": null,
        "contentTypeMetaInformation": null,
        "binary": null
      }
    ],
    "metaMapped": true,
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-08-24T14:15:22Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true,
      "language": "string"
    },
    "fullyAccessible": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<type>0</type>
<editable>true</editable>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</sharedGroups>
<alias>string</alias>
<workflow>0</workflow>
<systemTemplate>true</systemTemplate>
<sharedGroupCount>0</sharedGroupCount>
<contentTypeElements>
  <id/>
  <contentTypeID/>
  <name/>
  <description/>
  <type/>
  <maxSize/>
  <compulsory/>
  <input_method/>
  <listId/>
  <sequence/>
  <alias/>
  <contentTypeMetaInformation/>
  <binary/>
</contentTypeElements>
<metaMapped>true</metaMapped>
<lock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</lock>
<fullyAccessible>true</fullyAccessible>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ContentTypeMetaDataDTO] false none none
» sharedGroups [AssetSharingInformation] false none none
» metaMapped boolean false none none

getContentTypeScopes

GET /hierarchy/{id}/contenttypescopes

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "scope": 0,
    "inherited": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<scope>0</scope>
<inherited>true</inherited>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

mirror

GET /hierarchy/{id}/mirrors/{language}

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "parent": 0,
    "name": "string",
    "description": "string",
    "outputUrl": "string",
    "outputFilename": "string",
    "accessKey": "string",
    "keyPhrase": "string",
    "status": 0,
    "workflow": 0,
    "parentWorkflowName": "string",
    "show": true,
    "iseForm": true,
    "archive": true,
    "lastModified": "2019-08-24T14:15:22Z",
    "printSequence": 0,
    "contentSortMethod": 0,
    "sectionSortMethod": 0,
    "path": "string",
    "mirrorOf": 0,
    "sourceOfMirror": true,
    "link": true,
    "channels": [
      {
        "id": null,
        "pageLayout": null,
        "inheritedPageLayout": null,
        "valid": null
      }
    ],
    "userIDs": [
      0
    ],
    "inheritedUserIDs": [
      0
    ],
    "groupIDs": [
      0
    ],
    "inheritedGroupIDs": [
      0
    ],
    "viewUserIDs": [
      0
    ],
    "viewGroupIDs": [
      0
    ],
    "contentTypeScopes": [
      {
        "id": null,
        "scope": null,
        "inherited": null
      }
    ],
    "metaDatas": [
      {
        "id": null,
        "value": null,
        "lang": null
      }
    ],
    "linkInfo": {
      "type": 0,
      "section": 0,
      "url": "string",
      "language": "string",
      "target": "string",
      "accessControl": 0,
      "override": true,
      "overridden": true
    },
    "excludedMirrorSections": [
      0
    ],
    "workflowName": "string",
    "parentWorkflowID": 0,
    "accessControl": {
      "id": 0,
      "type": 0,
      "enabled": true,
      "active": true
    },
    "metaData": {
      "id": 0,
      "type": 0,
      "enabled": true,
      "active": true
    },
    "pathMembers": [
      0
    ],
    "sortLock": "TOP",
    "editable": true,
    "inheritedLinkSection": true,
    "accessControlEnabled": true,
    "accessControlType": 0,
    "metaDataType": 0,
    "accessControlInherited": true,
    "allowedGroups": [
      0
    ],
    "mirrorOfPath": "string",
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "outputUriEnabled": true,
    "publishEnabled": true,
    "outputFilenameEnabled": true,
    "spellCheckEnabled": true,
    "pathAsOutputUriEnabled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<parent>0</parent>
<name>string</name>
<description>string</description>
<outputUrl>string</outputUrl>
<outputFilename>string</outputFilename>
<accessKey>string</accessKey>
<keyPhrase>string</keyPhrase>
<status>0</status>
<workflow>0</workflow>
<parentWorkflowName>string</parentWorkflowName>
<show>true</show>
<iseForm>true</iseForm>
<archive>true</archive>
<lastModified>2019-08-24T14:15:22Z</lastModified>
<printSequence>0</printSequence>
<contentSortMethod>0</contentSortMethod>
<sectionSortMethod>0</sectionSortMethod>
<path>string</path>
<mirrorOf>0</mirrorOf>
<sourceOfMirror>true</sourceOfMirror>
<link>true</link>
<channels>
  <id/>
  <pageLayout/>
  <inheritedPageLayout/>
  <valid/>
</channels>
<userIDs>0</userIDs>
<inheritedUserIDs>0</inheritedUserIDs>
<groupIDs>0</groupIDs>
<inheritedGroupIDs>0</inheritedGroupIDs>
<viewUserIDs>0</viewUserIDs>
<viewGroupIDs>0</viewGroupIDs>
<contentTypeScopes>
  <id/>
  <scope/>
  <inherited/>
</contentTypeScopes>
<metaDatas>
  <id/>
  <value/>
  <lang/>
</metaDatas>
<linkInfo>
  <type>0</type>
  <section>0</section>
  <url>string</url>
  <language>string</language>
  <target>string</target>
  <accessControl>0</accessControl>
  <override>true</override>
  <overridden>true</overridden>
</linkInfo>
<excludedMirrorSections>0</excludedMirrorSections>
<workflowName>string</workflowName>
<parentWorkflowID>0</parentWorkflowID>
<accessControl>
  <id>0</id>
  <type>0</type>
  <enabled>true</enabled>
  <active>true</active>
</accessControl>
<metaData>
  <id>0</id>
  <type>0</type>
  <enabled>true</enabled>
  <active>true</active>
</metaData>
<pathMembers>0</pathMembers>
<sortLock>TOP</sortLock>
<editable>true</editable>
<inheritedLinkSection>true</inheritedLinkSection>
<accessControlEnabled>true</accessControlEnabled>
<accessControlType>0</accessControlType>
<metaDataType>0</metaDataType>
<accessControlInherited>true</accessControlInherited>
<allowedGroups>0</allowedGroups>
<mirrorOfPath>string</mirrorOfPath>
<inheritedPageLayouts>
  <property1>0</property1>
  <property2>0</property2>
</inheritedPageLayouts>
<outputUriEnabled>true</outputUriEnabled>
<publishEnabled>true</publishEnabled>
<outputFilenameEnabled>true</outputFilenameEnabled>
<spellCheckEnabled>true</spellCheckEnabled>
<pathAsOutputUriEnabled>true</pathAsOutputUriEnabled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getPath

GET /hierarchy/{id}/path

Parameters

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

Example responses

200 Response

[
  0
]

<?xml version="1.0" encoding="UTF-8" ?>0

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

get

GET /hierarchy/{id}/{language}

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
basic query boolean false none

Example responses

200 Response

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<SectionDTO>
  <id>0</id>
  <parent>0</parent>
  <name>string</name>
  <description>string</description>
  <outputUrl>string</outputUrl>
  <outputFilename>string</outputFilename>
  <accessKey>string</accessKey>
  <keyPhrase>string</keyPhrase>
  <status>0</status>
  <workflow>0</workflow>
  <parentWorkflowName>string</parentWorkflowName>
  <show>true</show>
  <iseForm>true</iseForm>
  <archive>true</archive>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <printSequence>0</printSequence>
  <contentSortMethod>0</contentSortMethod>
  <sectionSortMethod>0</sectionSortMethod>
  <path>string</path>
  <mirrorOf>0</mirrorOf>
  <sourceOfMirror>true</sourceOfMirror>
  <link>true</link>
  <channels>
    <id>0</id>
    <pageLayout>0</pageLayout>
    <inheritedPageLayout>0</inheritedPageLayout>
    <valid>true</valid>
  </channels>
  <userIDs>0</userIDs>
  <inheritedUserIDs>0</inheritedUserIDs>
  <groupIDs>0</groupIDs>
  <inheritedGroupIDs>0</inheritedGroupIDs>
  <viewUserIDs>0</viewUserIDs>
  <viewGroupIDs>0</viewGroupIDs>
  <contentTypeScopes>
    <id>0</id>
    <scope>0</scope>
    <inherited>true</inherited>
  </contentTypeScopes>
  <metaDatas>
    <id>0</id>
    <value>string</value>
    <lang>string</lang>
  </metaDatas>
  <linkInfo>
    <type>0</type>
    <section>0</section>
    <url>string</url>
    <language>string</language>
    <target>string</target>
    <accessControl>0</accessControl>
    <override>true</override>
    <overridden>true</overridden>
  </linkInfo>
  <excludedMirrorSections>0</excludedMirrorSections>
  <workflowName>string</workflowName>
  <parentWorkflowID>0</parentWorkflowID>
  <accessControl>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </accessControl>
  <metaData>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </metaData>
  <pathMembers>0</pathMembers>
  <sortLock>TOP</sortLock>
  <editable>true</editable>
  <inheritedLinkSection>true</inheritedLinkSection>
  <accessControlEnabled>true</accessControlEnabled>
  <accessControlType>0</accessControlType>
  <metaDataType>0</metaDataType>
  <accessControlInherited>true</accessControlInherited>
  <allowedGroups>0</allowedGroups>
  <mirrorOfPath>string</mirrorOfPath>
  <inheritedPageLayouts>
    <property1>0</property1>
    <property2>0</property2>
  </inheritedPageLayouts>
  <outputUriEnabled>true</outputUriEnabled>
  <publishEnabled>true</publishEnabled>
  <outputFilenameEnabled>true</outputFilenameEnabled>
  <spellCheckEnabled>true</spellCheckEnabled>
  <pathAsOutputUriEnabled>true</pathAsOutputUriEnabled>
</SectionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation SectionDTO

update

PUT /hierarchy/{id}/{language}

Parameters

Name In Type Required Description
language path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

add

POST /hierarchy/{language}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<SectionDTO>
  <id>0</id>
  <parent>0</parent>
  <name>string</name>
  <description>string</description>
  <outputUrl>string</outputUrl>
  <outputFilename>string</outputFilename>
  <accessKey>string</accessKey>
  <keyPhrase>string</keyPhrase>
  <status>0</status>
  <workflow>0</workflow>
  <parentWorkflowName>string</parentWorkflowName>
  <show>true</show>
  <iseForm>true</iseForm>
  <archive>true</archive>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <printSequence>0</printSequence>
  <contentSortMethod>0</contentSortMethod>
  <sectionSortMethod>0</sectionSortMethod>
  <path>string</path>
  <mirrorOf>0</mirrorOf>
  <sourceOfMirror>true</sourceOfMirror>
  <link>true</link>
  <channels>
    <id>0</id>
    <pageLayout>0</pageLayout>
    <inheritedPageLayout>0</inheritedPageLayout>
    <valid>true</valid>
  </channels>
  <userIDs>0</userIDs>
  <inheritedUserIDs>0</inheritedUserIDs>
  <groupIDs>0</groupIDs>
  <inheritedGroupIDs>0</inheritedGroupIDs>
  <viewUserIDs>0</viewUserIDs>
  <viewGroupIDs>0</viewGroupIDs>
  <contentTypeScopes>
    <id>0</id>
    <scope>0</scope>
    <inherited>true</inherited>
  </contentTypeScopes>
  <metaDatas>
    <id>0</id>
    <value>string</value>
    <lang>string</lang>
  </metaDatas>
  <linkInfo>
    <type>0</type>
    <section>0</section>
    <url>string</url>
    <language>string</language>
    <target>string</target>
    <accessControl>0</accessControl>
    <override>true</override>
    <overridden>true</overridden>
  </linkInfo>
  <excludedMirrorSections>0</excludedMirrorSections>
  <workflowName>string</workflowName>
  <parentWorkflowID>0</parentWorkflowID>
  <accessControl>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </accessControl>
  <metaData>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </metaData>
  <pathMembers>0</pathMembers>
  <sortLock>TOP</sortLock>
  <editable>true</editable>
  <inheritedLinkSection>true</inheritedLinkSection>
  <accessControlEnabled>true</accessControlEnabled>
  <accessControlType>0</accessControlType>
  <metaDataType>0</metaDataType>
  <accessControlInherited>true</accessControlInherited>
  <allowedGroups>0</allowedGroups>
  <mirrorOfPath>string</mirrorOfPath>
  <inheritedPageLayouts>
    <property1>0</property1>
    <property2>0</property2>
  </inheritedPageLayouts>
  <outputUriEnabled>true</outputUriEnabled>
  <publishEnabled>true</publishEnabled>
  <outputFilenameEnabled>true</outputFilenameEnabled>
  <spellCheckEnabled>true</spellCheckEnabled>
  <pathAsOutputUriEnabled>true</pathAsOutputUriEnabled>
</SectionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation SectionDTO

hierarchy{id}{language}contents

Describes web service operations relating to content in a section.

get

GET /hierarchy/{id}/{language}/contents

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
showAll query boolean false none
removeNonTranslated query boolean false none
directEdit query boolean false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK successful operation SectionChildListingDtoSectionContentDto

updateSectionContentIndexes

PUT /hierarchy/{id}/{language}/contents

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

bulkDelete

DELETE /hierarchy/{id}/{language}/contents/bulkdelete

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

updateContentSortType

PUT /hierarchy/{id}/{language}/contents/sorttype

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /hierarchy/{id}/{language}/contents/{contentId}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

updateContentIndex

PUT /hierarchy/{id}/{language}/contents/{contentId}/index

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

updateContentLock

PUT /hierarchy/{id}/{language}/contents/{contentId}/lock

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

hierarchy{id}{language}subsections

These endpoints describe functionality around accessing subsections belonging to a section.

get

GET /hierarchy/{id}/{language}/subsections

Parameters

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

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK successful operation SectionChildListingDtoSectionMetaDataDTO

updateSectionContentIndexes

PUT /hierarchy/{id}/{language}/subsections

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

updateSubsectionSortType

PUT /hierarchy/{id}/{language}/subsections/sorttype

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

updateSubsectionIndex

PUT /hierarchy/{id}/{language}/subsections/{contentId}/index

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

updateSubsectionLock

PUT /hierarchy/{id}/{language}/subsections/{contentId}/lock

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

htmlEditor

These endpoints describe operations on the HTML Editors in use by the TERMINALFOUR system.

list

GET /htmlEditor

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "minimumAccessLevel": 0,
    "classname": "string",
    "configurationOptions": [
      {
        "id": null,
        "htmlEditorId": null,
        "name": null,
        "value": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<minimumAccessLevel>0</minimumAccessLevel>
<classname>string</classname>
<configurationOptions>
  <id/>
  <htmlEditorId/>
  <name/>
  <value/>
</configurationOptions>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /htmlEditor

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "minimumAccessLevel": 0,
  "classname": "string",
  "configurationOptions": [
    {
      "id": 0,
      "htmlEditorId": 0,
      "name": "string",
      "value": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<HtmlEditorMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <minimumAccessLevel>0</minimumAccessLevel>
  <classname>string</classname>
  <configurationOptions>
    <id>0</id>
    <htmlEditorId>0</htmlEditorId>
    <name>string</name>
    <value>string</value>
  </configurationOptions>
</HtmlEditorMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation HtmlEditorMetaDataDTO

get

GET /htmlEditor/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "minimumAccessLevel": 0,
  "classname": "string",
  "configurationOptions": [
    {
      "id": 0,
      "htmlEditorId": 0,
      "name": "string",
      "value": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<HtmlEditorMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <minimumAccessLevel>0</minimumAccessLevel>
  <classname>string</classname>
  <configurationOptions>
    <id>0</id>
    <htmlEditorId>0</htmlEditorId>
    <name>string</name>
    <value>string</value>
  </configurationOptions>
</HtmlEditorMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation HtmlEditorMetaDataDTO

update

PUT /htmlEditor/{id}

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "minimumAccessLevel": 0,
  "classname": "string",
  "configurationOptions": [
    {
      "id": 0,
      "htmlEditorId": 0,
      "name": "string",
      "value": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<HtmlEditorMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <minimumAccessLevel>0</minimumAccessLevel>
  <classname>string</classname>
  <configurationOptions>
    <id>0</id>
    <htmlEditorId>0</htmlEditorId>
    <name>string</name>
    <value>string</value>
  </configurationOptions>
</HtmlEditorMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation HtmlEditorMetaDataDTO

delete

DELETE /htmlEditor/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

htmleditorconfig

This service describes the operations that relate to the configuration of HTML editors.

get

GET /htmleditorconfig

Example responses

200 Response

{
  "editorInstanceName": "string",
  "defaultCustomStyleMedia": "string",
  "extraHideIcons": "string",
  "enabledPlugins": [
    "string"
  ],
  "invalidElements": "string",
  "extendedValidElements": "string",
  "themeAdvancedBlockformats": "string",
  "menuCustomItems": "string",
  "toolbarCustomItems": "string",
  "customStyleEnabled": true,
  "hideIcons": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<TinyMCEEditorConfiguration>
  <editorInstanceName>string</editorInstanceName>
  <defaultCustomStyleMedia>string</defaultCustomStyleMedia>
  <extraHideIcons>string</extraHideIcons>
  <enabledPlugins>string</enabledPlugins>
  <invalidElements>string</invalidElements>
  <extendedValidElements>string</extendedValidElements>
  <themeAdvancedBlockformats>string</themeAdvancedBlockformats>
  <menuCustomItems>string</menuCustomItems>
  <toolbarCustomItems>string</toolbarCustomItems>
  <customStyleEnabled>true</customStyleEnabled>
  <hideIcons>string</hideIcons>
</TinyMCEEditorConfiguration>

Responses

Status Meaning Description Schema
200 OK successful operation TinyMCEEditorConfiguration

getCustomPlugins

GET /htmleditorconfig/plugins

Example responses

200 Response

{
  "fileNames": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<TinyMcePluginsDTO>
  <fileNames>string</fileNames>
</TinyMcePluginsDTO>

Responses

Status Meaning Description Schema
200 OK successful operation TinyMcePluginsDTO

removePlugins

POST /htmleditorconfig/plugins/{pluginToRemove}

Parameters

Name In Type Required Description
pluginToRemove path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

upload

POST /htmleditorconfig/upload

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

getDefaults

GET /htmleditorconfig/{returnDefaults}

Parameters

Name In Type Required Description
returnDefaults path boolean true none

Example responses

200 Response

{
  "editorInstanceName": "string",
  "defaultCustomStyleMedia": "string",
  "extraHideIcons": "string",
  "enabledPlugins": [
    "string"
  ],
  "invalidElements": "string",
  "extendedValidElements": "string",
  "themeAdvancedBlockformats": "string",
  "menuCustomItems": "string",
  "toolbarCustomItems": "string",
  "customStyleEnabled": true,
  "hideIcons": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<TinyMCEEditorConfiguration>
  <editorInstanceName>string</editorInstanceName>
  <defaultCustomStyleMedia>string</defaultCustomStyleMedia>
  <extraHideIcons>string</extraHideIcons>
  <enabledPlugins>string</enabledPlugins>
  <invalidElements>string</invalidElements>
  <extendedValidElements>string</extendedValidElements>
  <themeAdvancedBlockformats>string</themeAdvancedBlockformats>
  <menuCustomItems>string</menuCustomItems>
  <toolbarCustomItems>string</toolbarCustomItems>
  <customStyleEnabled>true</customStyleEnabled>
  <hideIcons>string</hideIcons>
</TinyMCEEditorConfiguration>

Responses

Status Meaning Description Schema
200 OK successful operation TinyMCEEditorConfiguration

keystore

These endpoints describe the functionality of the TERMINALFOUR keystore.

list

POST /keystore/list

Example responses

200 Response

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "id": 0,
      "keyName": "string",
      "keyDescription": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "keys": "string",
      "inUse": true,
      "usedFor": [
        null
      ],
      "itAPrivateKey": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<TableData>
  <draw>0</draw>
  <recordsTotal>0</recordsTotal>
  <recordsFiltered>0</recordsFiltered>
  <data>
    <id>0</id>
    <keyName>string</keyName>
    <keyDescription>string</keyDescription>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <keys>string</keys>
    <inUse>true</inUse>
    <usedFor/>
    <itAPrivateKey>true</itAPrivateKey>
  </data>
</TableData>

Responses

Status Meaning Description Schema
200 OK successful operation TableData

add

POST /keystore

Example responses

200 Response

{
  "id": 0,
  "keyName": "string",
  "keyDescription": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "keys": "string",
  "privateKey": "string",
  "keyPassword": "string",
  "inUse": true,
  "usedFor": [
    "string"
  ],
  "itAPrivateKey": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<Key>
  <id>0</id>
  <keyName>string</keyName>
  <keyDescription>string</keyDescription>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <keys>string</keys>
  <privateKey>string</privateKey>
  <keyPassword>string</keyPassword>
  <inUse>true</inUse>
  <usedFor>string</usedFor>
  <itAPrivateKey>true</itAPrivateKey>
</Key>

Responses

Status Meaning Description Schema
200 OK successful operation Key

get

GET /keystore/{keyId}

Parameters

Name In Type Required Description
keyId path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "keyName": "string",
  "keyDescription": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "keys": "string",
  "inUse": true,
  "usedFor": [
    "string"
  ],
  "itAPrivateKey": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<KeyMeta>
  <id>0</id>
  <keyName>string</keyName>
  <keyDescription>string</keyDescription>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <keys>string</keys>
  <inUse>true</inUse>
  <usedFor>string</usedFor>
  <itAPrivateKey>true</itAPrivateKey>
</KeyMeta>

Responses

Status Meaning Description Schema
200 OK successful operation KeyMeta

modify

PUT /keystore/{keyId}

Example responses

200 Response

{
  "id": 0,
  "keyName": "string",
  "keyDescription": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "keys": "string",
  "privateKey": "string",
  "keyPassword": "string",
  "inUse": true,
  "usedFor": [
    "string"
  ],
  "itAPrivateKey": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<Key>
  <id>0</id>
  <keyName>string</keyName>
  <keyDescription>string</keyDescription>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <keys>string</keys>
  <privateKey>string</privateKey>
  <keyPassword>string</keyPassword>
  <inUse>true</inUse>
  <usedFor>string</usedFor>
  <itAPrivateKey>true</itAPrivateKey>
</Key>

Responses

Status Meaning Description Schema
200 OK successful operation Key

delete

DELETE /keystore/{keyId}

Parameters

Name In Type Required Description
keyId path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

language

These endpoints provide the functionality for the languages in the TERMINALFOUR system.

list

GET /language

Parameters

Name In Type Required Description
pageNumber query integer(int32) false none
pageSize query integer(int32) false none

Example responses

200 Response

[
  {
    "code": "string",
    "name": "string",
    "charset": "string",
    "disclaimer": "string",
    "channels": [
      {
        "id": null,
        "name": null,
        "description": null,
        "type": null,
        "defaultLanguage": null,
        "rootSectionID": null,
        "fileOutputPath": null,
        "indexFileName": null,
        "baseHref": null,
        "siteRoot": null,
        "pathCaseModifier": null,
        "fullTextType": null,
        "fullTextExtension": null,
        "secondaryPublishLanguage": null,
        "channelPublishURL": null,
        "parent": null,
        "favIconID": null,
        "pollIconID": null,
        "accessControlConfigurationID": null,
        "personalisationConfigurationID": null,
        "publishReportLevel": null,
        "pendingVersionOutputPath": null,
        "pendingVersionBaseHref": null,
        "pendingVersionSiteRoot": null,
        "prePublishProcessorID": null,
        "allowScriptsInDirectEdit": null,
        "pxlFolder": null,
        "languages": null,
        "microSites": null,
        "permittedFileExtensions": null,
        "translationDisclaimers": null,
        "mediaPublishRules": null,
        "channelFullTextDisplayPeriod": null,
        "channelUsers": null,
        "channelContents": null,
        "mediaTypesWithPublishRuleCategory": null,
        "convertSpacesInSectionNameEnabled": null,
        "convertSpacesInRetainedFilenameEnabled": null,
        "channelCleanupEnabled": null,
        "personalisationEnabled": null,
        "accessControlEnabled": null,
        "fullTextDisplayPeriodValue": null,
        "fullTextDisplayPeriodUnit": null,
        "secondaryPublishEnabled": null,
        "overrideExtensionEnabled": null,
        "publishEmptySectionsEnabled": null,
        "convertSpacesInOutputURIEnabled": null,
        "parentID": null,
        "contentIDs": null,
        "languageCodes": null,
        "microSite": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<code>string</code>
<name>string</name>
<charset>string</charset>
<disclaimer>string</disclaimer>
<channels>
  <id/>
  <name/>
  <description/>
  <type/>
  <defaultLanguage/>
  <rootSectionID/>
  <fileOutputPath/>
  <indexFileName/>
  <baseHref/>
  <siteRoot/>
  <pathCaseModifier/>
  <fullTextType/>
  <fullTextExtension/>
  <secondaryPublishLanguage/>
  <channelPublishURL/>
  <parent/>
  <favIconID/>
  <pollIconID/>
  <accessControlConfigurationID/>
  <personalisationConfigurationID/>
  <publishReportLevel/>
  <pendingVersionOutputPath/>
  <pendingVersionBaseHref/>
  <pendingVersionSiteRoot/>
  <prePublishProcessorID/>
  <allowScriptsInDirectEdit/>
  <pxlFolder/>
  <languages/>
  <microSites/>
  <permittedFileExtensions/>
  <translationDisclaimers/>
  <mediaPublishRules/>
  <channelFullTextDisplayPeriod/>
  <channelUsers/>
  <channelContents/>
  <mediaTypesWithPublishRuleCategory/>
  <convertSpacesInSectionNameEnabled/>
  <convertSpacesInRetainedFilenameEnabled/>
  <channelCleanupEnabled/>
  <personalisationEnabled/>
  <accessControlEnabled/>
  <fullTextDisplayPeriodValue/>
  <fullTextDisplayPeriodUnit/>
  <secondaryPublishEnabled/>
  <overrideExtensionEnabled/>
  <publishEmptySectionsEnabled/>
  <convertSpacesInOutputURIEnabled/>
  <parentID/>
  <contentIDs/>
  <languageCodes/>
  <microSite/>
</channels>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Language] false none none
»»» priority integer(int32) false none none
»»» disclaimer string false none none
»»» publishRule integer(int32) false none none
»»»»»»» languageCount integer(int32) false none none
»»»»»» printSequence integer(int32) false none none
»»»»»» sortLock string false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» entityID integer(int32) false none none
»»»»»» contentID integer(int32) false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» pageLayoutID integer(int32) false none none
»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»» elementForFilename integer(int32) false none none
»»»»»»» alias string false none none
»»»»»»» directEditEnabled boolean false none none
»»»»»»»»» sequence integer(int32) false none none
»»»»»»»» restricted boolean false none none
»»»»»»» duplicate boolean false none none
»»»»»»» type integer(int32) false none none
»»»»»»» sectionID integer(int32) false none none
»»»»»»» minAuthLevel integer(int32) false none none
»»»»»» scope integer(int32) false none none
»»»»»» contentTypeID integer(int32) false none none
»»»»» sortLock string false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

get

GET /language/{code}

Parameters

Name In Type Required Description
code path string true none

Example responses

200 Response

{
  "code": "string",
  "name": "string",
  "charset": "string",
  "disclaimer": "string",
  "modified": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<LanguageDTO>
  <code>string</code>
  <name>string</name>
  <charset>string</charset>
  <disclaimer>string</disclaimer>
  <modified>true</modified>
</LanguageDTO>

Responses

Status Meaning Description Schema
200 OK successful operation LanguageDTO

addOrModify

PUT /language/{code}

Parameters

Name In Type Required Description
code path string true none

Example responses

200 Response

{
  "code": "string",
  "name": "string",
  "charset": "string",
  "disclaimer": "string",
  "modified": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<LanguageDTO>
  <code>string</code>
  <name>string</name>
  <charset>string</charset>
  <disclaimer>string</disclaimer>
  <modified>true</modified>
</LanguageDTO>

Responses

Status Meaning Description Schema
200 OK successful operation LanguageDTO

delete

DELETE /language/{code}

Parameters

Name In Type Required Description
code path string true none

Example responses

200 Response

{
  "code": "string",
  "name": "string",
  "charset": "string",
  "disclaimer": "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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<language>
  <code>string</code>
  <name>string</name>
  <charset>string</charset>
  <disclaimer>string</disclaimer>
  <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>
    <pxlFolder>string</pxlFolder>
    <languages/>
    <microSites/>
    <permittedFileExtensions/>
    <translationDisclaimers/>
    <mediaPublishRules/>
    <channelFullTextDisplayPeriod/>
    <channelUsers/>
    <channelContents/>
    <mediaTypesWithPublishRuleCategory/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <parentID>0</parentID>
    <contentIDs/>
    <languageCodes/>
    <microSite>true</microSite>
  </channels>
</language>

Responses

Status Meaning Description Schema
200 OK successful operation Language

layout

These endpoints describe operations on Content Layouts within the TERMINALFOUR system.

list

GET /layout/contenttype/{id}/{language}

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {
        "language": null,
        "name": null
      }
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": 0,
      "type": "["
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-08-24T14:15:22Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true,
      "language": "string"
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-08-24T14:15:22Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true,
      "language": "string"
    },
    "locked": true,
    "sectionIDs": [
      0
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<contentTypeID>0</contentTypeID>
<archiveSection>0</archiveSection>
<publishDate>2019-08-24T14:15:22Z</publishDate>
<reviewDate>2019-08-24T14:15:22Z</reviewDate>
<expiryDate>2019-08-24T14:15:22Z</expiryDate>
<language>string</language>
<name>string</name>
<alternativeLanguages>
  <language/>
  <name/>
</alternativeLanguages>
<status>0</status>
<lastModified>2019-08-24T14:15:22Z</lastModified>
<lastModifiedBy>0</lastModifiedBy>
<lastModifierName>string</lastModifierName>
<contentTypeName>string</contentTypeName>
<contentTypeAlias>string</contentTypeAlias>
<owner>
  <id>0</id>
  <type>[</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-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</lock>
<canPublishNow>true</canPublishNow>
<canSaveAndApprove>true</canSaveAndApprove>
<contentTypeAccess>0</contentTypeAccess>
<contentTypeLock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</contentTypeLock>
<locked>true</locked>
<sectionIDs>0</sectionIDs>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /layout/{id}/{language}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

add

PUT /layout/{contenttypeid}

Parameters

Name In Type Required Description
contenttypeid path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

modify

PUT /layout/{id}/{language}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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

delete

DELETE /layout/{id}/{language}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

ldapcontext

These endpoints provide the functionality for the LDAP login contexts in the TERMINALFOUR system.

list

GET /ldap/context

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "context": "string",
    "authLevel": 0,
    "defaultAuthMethod": 0,
    "group": 0,
    "filters": [
      {
        "id": null,
        "contextID": null,
        "attribute": null,
        "value": null,
        "exclude": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<context>string</context>
<authLevel>0</authLevel>
<defaultAuthMethod>0</defaultAuthMethod>
<group>0</group>
<filters>
  <id/>
  <contextID/>
  <attribute/>
  <value/>
  <exclude/>
</filters>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /ldap/context

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /ldap/context/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "context": "string",
  "authLevel": 0,
  "defaultAuthMethod": 0,
  "group": 0,
  "filters": [
    {
      "id": 0,
      "contextID": 0,
      "attribute": "string",
      "value": "string",
      "exclude": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<login_context>
  <id>0</id>
  <name>string</name>
  <context>string</context>
  <authLevel>0</authLevel>
  <defaultAuthMethod>0</defaultAuthMethod>
  <group>0</group>
  <filters>
    <id>0</id>
    <contextID>0</contextID>
    <attribute>string</attribute>
    <value>string</value>
    <exclude>true</exclude>
  </filters>
</login_context>

Responses

Status Meaning Description Schema
200 OK successful operation LDAPLoginContext

modify

PUT /ldap/context/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /ldap/context/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

licence

These web service endpoints provide the functionality for the TERMINALFOUR licence system.

list

GET /licence

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "modified": {
      "date": "string",
      "user": {}
    },
    "order": 0,
    "valid": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<modified>
  <date>string</date>
  <user/>
</modified>
<order>0</order>
<valid>true</valid>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [LicenceMetaDataDTO] false none none
»»»»»»»»» priority integer(int32) false none none
»»»»»»»»» disclaimer string false none none
»»»»»»»»» publishRule integer(int32) false none none
»»»»»»» contentVersions object false none none
»»»»»»» languageCount integer(int32) false none none
»»»»»» printSequence integer(int32) false none none
»»»»»» sortLock string false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» entityID integer(int32) false none none
»»»»»» contentID integer(int32) false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» pageLayoutID integer(int32) false none none
»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»» elementForFilename integer(int32) false none none
»»»»»»» alias string false none none
»»»»»»» directEditEnabled boolean false none none
»»»»»»»»» sequence integer(int32) false none none
»»»»»»»» restricted boolean false none none
»»»»»»» duplicate boolean false none none
»»»»»»» type integer(int32) false none none
»»»»»»» sectionID integer(int32) false none none
»»»»»»» minAuthLevel integer(int32) false none none
»»»»»» scope integer(int32) false none none
»»»»»» contentTypeID integer(int32) false none none
»»»»» sortLock string false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
» order integer(int32) false none none
» valid boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

add

POST /licence

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "modified": {
    "date": "string",
    "user": {
      "id": null,
      "username": null,
      "firstName": null,
      "lastName": null,
      "emailAddress": null,
      "defaultLang": null,
      "localeCountryCode": null,
      "localeLanguageCode": null,
      "localeVariant": null,
      "createDate": null,
      "lastLoginDate": null,
      "enabled": null,
      "password": null,
      "defaultPreviewChannel": null,
      "preferredHtmlEditor": null,
      "extranetConsent": null,
      "extranetAccess": null,
      "extranetConsentDatetime": null,
      "groups": null,
      "extensibleUserObjectContent": null,
      "sections": null,
      "userChannels": null,
      "locale": null,
      "fullName": null,
      "deleted": null,
      "powerUser": null,
      "administrator": null,
      "authLevel": null,
      "fullTinyMCELocaleCode": null,
      "appliedPreviewChannel": null,
      "propertyResourceBundle": null,
      "fullLocaleCode": null
    }
  },
  "order": 0,
  "valid": true,
  "key": "string",
  "validatedInfo": {
    "licencee": {
      "companyName": null,
      "registeredOffice": null,
      "territory": null,
      "companyStatus": null
    },
    "licenceContact": {
      "salutation": null,
      "firstname": null,
      "lastname": null,
      "email": null,
      "legalSalutation": null,
      "legalFirstname": null,
      "legalLastname": null
    },
    "partnerDetails": {
      "name": null,
      "partnerSalutation": null,
      "partnerFirstname": null,
      "partnerLastname": null
    },
    "licenceDetails": {
      "productLicenced": null,
      "begins": null,
      "ends": null,
      "hostname": null
    },
    "restrictions": {
      "content": null,
      "user": null,
      "channel": null,
      "workflow": null,
      "contentType": null,
      "language": null
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<licence>
  <id>0</id>
  <name>string</name>
  <modified>
    <date>string</date>
    <user>
      <id/>
      <username/>
      <firstName/>
      <lastName/>
      <emailAddress/>
      <defaultLang/>
      <localeCountryCode/>
      <localeLanguageCode/>
      <localeVariant/>
      <createDate/>
      <lastLoginDate/>
      <enabled/>
      <password/>
      <defaultPreviewChannel/>
      <preferredHtmlEditor/>
      <extranetConsent/>
      <extranetAccess/>
      <extranetConsentDatetime/>
      <groups/>
      <extensibleUserObjectContent/>
      <sections/>
      <userChannels/>
      <locale/>
      <fullName/>
      <deleted/>
      <powerUser/>
      <administrator/>
      <authLevel/>
      <fullTinyMCELocaleCode/>
      <appliedPreviewChannel/>
      <propertyResourceBundle/>
      <fullLocaleCode/>
    </user>
  </modified>
  <order>0</order>
  <valid>true</valid>
  <key>string</key>
  <validatedInfo>
    <licencee>
      <companyName/>
      <registeredOffice/>
      <territory/>
      <companyStatus/>
    </licencee>
    <licenceContact>
      <salutation/>
      <firstname/>
      <lastname/>
      <email/>
      <legalSalutation/>
      <legalFirstname/>
      <legalLastname/>
    </licenceContact>
    <partnerDetails>
      <name/>
      <partnerSalutation/>
      <partnerFirstname/>
      <partnerLastname/>
    </partnerDetails>
    <licenceDetails>
      <productLicenced/>
      <begins/>
      <ends/>
      <hostname/>
    </licenceDetails>
    <restrictions>
      <content/>
      <user/>
      <channel/>
      <workflow/>
      <contentType/>
      <language/>
    </restrictions>
  </validatedInfo>
</licence>

Responses

Status Meaning Description Schema
200 OK successful operation LicenceDTO

licenseContentsLimitExceeded

GET /licence/contentslimit

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK successful operation boolean

get

GET /licence/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "modified": {
    "date": "string",
    "user": {
      "id": null,
      "username": null,
      "firstName": null,
      "lastName": null,
      "emailAddress": null,
      "defaultLang": null,
      "localeCountryCode": null,
      "localeLanguageCode": null,
      "localeVariant": null,
      "createDate": null,
      "lastLoginDate": null,
      "enabled": null,
      "password": null,
      "defaultPreviewChannel": null,
      "preferredHtmlEditor": null,
      "extranetConsent": null,
      "extranetAccess": null,
      "extranetConsentDatetime": null,
      "groups": null,
      "extensibleUserObjectContent": null,
      "sections": null,
      "userChannels": null,
      "locale": null,
      "fullName": null,
      "deleted": null,
      "powerUser": null,
      "administrator": null,
      "authLevel": null,
      "fullTinyMCELocaleCode": null,
      "appliedPreviewChannel": null,
      "propertyResourceBundle": null,
      "fullLocaleCode": null
    }
  },
  "order": 0,
  "valid": true,
  "key": "string",
  "validatedInfo": {
    "licencee": {
      "companyName": null,
      "registeredOffice": null,
      "territory": null,
      "companyStatus": null
    },
    "licenceContact": {
      "salutation": null,
      "firstname": null,
      "lastname": null,
      "email": null,
      "legalSalutation": null,
      "legalFirstname": null,
      "legalLastname": null
    },
    "partnerDetails": {
      "name": null,
      "partnerSalutation": null,
      "partnerFirstname": null,
      "partnerLastname": null
    },
    "licenceDetails": {
      "productLicenced": null,
      "begins": null,
      "ends": null,
      "hostname": null
    },
    "restrictions": {
      "content": null,
      "user": null,
      "channel": null,
      "workflow": null,
      "contentType": null,
      "language": null
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<licence>
  <id>0</id>
  <name>string</name>
  <modified>
    <date>string</date>
    <user>
      <id/>
      <username/>
      <firstName/>
      <lastName/>
      <emailAddress/>
      <defaultLang/>
      <localeCountryCode/>
      <localeLanguageCode/>
      <localeVariant/>
      <createDate/>
      <lastLoginDate/>
      <enabled/>
      <password/>
      <defaultPreviewChannel/>
      <preferredHtmlEditor/>
      <extranetConsent/>
      <extranetAccess/>
      <extranetConsentDatetime/>
      <groups/>
      <extensibleUserObjectContent/>
      <sections/>
      <userChannels/>
      <locale/>
      <fullName/>
      <deleted/>
      <powerUser/>
      <administrator/>
      <authLevel/>
      <fullTinyMCELocaleCode/>
      <appliedPreviewChannel/>
      <propertyResourceBundle/>
      <fullLocaleCode/>
    </user>
  </modified>
  <order>0</order>
  <valid>true</valid>
  <key>string</key>
  <validatedInfo>
    <licencee>
      <companyName/>
      <registeredOffice/>
      <territory/>
      <companyStatus/>
    </licencee>
    <licenceContact>
      <salutation/>
      <firstname/>
      <lastname/>
      <email/>
      <legalSalutation/>
      <legalFirstname/>
      <legalLastname/>
    </licenceContact>
    <partnerDetails>
      <name/>
      <partnerSalutation/>
      <partnerFirstname/>
      <partnerLastname/>
    </partnerDetails>
    <licenceDetails>
      <productLicenced/>
      <begins/>
      <ends/>
      <hostname/>
    </licenceDetails>
    <restrictions>
      <content/>
      <user/>
      <channel/>
      <workflow/>
      <contentType/>
      <language/>
    </restrictions>
  </validatedInfo>
</licence>

Responses

Status Meaning Description Schema
200 OK successful operation LicenceDTO

modify

PUT /licence/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "modified": {
    "date": "string",
    "user": {
      "id": null,
      "username": null,
      "firstName": null,
      "lastName": null,
      "emailAddress": null,
      "defaultLang": null,
      "localeCountryCode": null,
      "localeLanguageCode": null,
      "localeVariant": null,
      "createDate": null,
      "lastLoginDate": null,
      "enabled": null,
      "password": null,
      "defaultPreviewChannel": null,
      "preferredHtmlEditor": null,
      "extranetConsent": null,
      "extranetAccess": null,
      "extranetConsentDatetime": null,
      "groups": null,
      "extensibleUserObjectContent": null,
      "sections": null,
      "userChannels": null,
      "locale": null,
      "fullName": null,
      "deleted": null,
      "powerUser": null,
      "administrator": null,
      "authLevel": null,
      "fullTinyMCELocaleCode": null,
      "appliedPreviewChannel": null,
      "propertyResourceBundle": null,
      "fullLocaleCode": null
    }
  },
  "order": 0,
  "valid": true,
  "key": "string",
  "validatedInfo": {
    "licencee": {
      "companyName": null,
      "registeredOffice": null,
      "territory": null,
      "companyStatus": null
    },
    "licenceContact": {
      "salutation": null,
      "firstname": null,
      "lastname": null,
      "email": null,
      "legalSalutation": null,
      "legalFirstname": null,
      "legalLastname": null
    },
    "partnerDetails": {
      "name": null,
      "partnerSalutation": null,
      "partnerFirstname": null,
      "partnerLastname": null
    },
    "licenceDetails": {
      "productLicenced": null,
      "begins": null,
      "ends": null,
      "hostname": null
    },
    "restrictions": {
      "content": null,
      "user": null,
      "channel": null,
      "workflow": null,
      "contentType": null,
      "language": null
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<licence>
  <id>0</id>
  <name>string</name>
  <modified>
    <date>string</date>
    <user>
      <id/>
      <username/>
      <firstName/>
      <lastName/>
      <emailAddress/>
      <defaultLang/>
      <localeCountryCode/>
      <localeLanguageCode/>
      <localeVariant/>
      <createDate/>
      <lastLoginDate/>
      <enabled/>
      <password/>
      <defaultPreviewChannel/>
      <preferredHtmlEditor/>
      <extranetConsent/>
      <extranetAccess/>
      <extranetConsentDatetime/>
      <groups/>
      <extensibleUserObjectContent/>
      <sections/>
      <userChannels/>
      <locale/>
      <fullName/>
      <deleted/>
      <powerUser/>
      <administrator/>
      <authLevel/>
      <fullTinyMCELocaleCode/>
      <appliedPreviewChannel/>
      <propertyResourceBundle/>
      <fullLocaleCode/>
    </user>
  </modified>
  <order>0</order>
  <valid>true</valid>
  <key>string</key>
  <validatedInfo>
    <licencee>
      <companyName/>
      <registeredOffice/>
      <territory/>
      <companyStatus/>
    </licencee>
    <licenceContact>
      <salutation/>
      <firstname/>
      <lastname/>
      <email/>
      <legalSalutation/>
      <legalFirstname/>
      <legalLastname/>
    </licenceContact>
    <partnerDetails>
      <name/>
      <partnerSalutation/>
      <partnerFirstname/>
      <partnerLastname/>
    </partnerDetails>
    <licenceDetails>
      <productLicenced/>
      <begins/>
      <ends/>
      <hostname/>
    </licenceDetails>
    <restrictions>
      <content/>
      <user/>
      <channel/>
      <workflow/>
      <contentType/>
      <language/>
    </restrictions>
  </validatedInfo>
</licence>

Responses

Status Meaning Description Schema
200 OK successful operation LicenceDTO

delete

DELETE /licence/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "modified": {
    "date": "string",
    "user": {
      "id": null,
      "username": null,
      "firstName": null,
      "lastName": null,
      "emailAddress": null,
      "defaultLang": null,
      "localeCountryCode": null,
      "localeLanguageCode": null,
      "localeVariant": null,
      "createDate": null,
      "lastLoginDate": null,
      "enabled": null,
      "password": null,
      "defaultPreviewChannel": null,
      "preferredHtmlEditor": null,
      "extranetConsent": null,
      "extranetAccess": null,
      "extranetConsentDatetime": null,
      "groups": null,
      "extensibleUserObjectContent": null,
      "sections": null,
      "userChannels": null,
      "locale": null,
      "fullName": null,
      "deleted": null,
      "powerUser": null,
      "administrator": null,
      "authLevel": null,
      "fullTinyMCELocaleCode": null,
      "appliedPreviewChannel": null,
      "propertyResourceBundle": null,
      "fullLocaleCode": null
    }
  },
  "order": 0,
  "valid": true,
  "key": "string",
  "validatedInfo": {
    "licencee": {
      "companyName": null,
      "registeredOffice": null,
      "territory": null,
      "companyStatus": null
    },
    "licenceContact": {
      "salutation": null,
      "firstname": null,
      "lastname": null,
      "email": null,
      "legalSalutation": null,
      "legalFirstname": null,
      "legalLastname": null
    },
    "partnerDetails": {
      "name": null,
      "partnerSalutation": null,
      "partnerFirstname": null,
      "partnerLastname": null
    },
    "licenceDetails": {
      "productLicenced": null,
      "begins": null,
      "ends": null,
      "hostname": null
    },
    "restrictions": {
      "content": null,
      "user": null,
      "channel": null,
      "workflow": null,
      "contentType": null,
      "language": null
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<licence>
  <id>0</id>
  <name>string</name>
  <modified>
    <date>string</date>
    <user>
      <id/>
      <username/>
      <firstName/>
      <lastName/>
      <emailAddress/>
      <defaultLang/>
      <localeCountryCode/>
      <localeLanguageCode/>
      <localeVariant/>
      <createDate/>
      <lastLoginDate/>
      <enabled/>
      <password/>
      <defaultPreviewChannel/>
      <preferredHtmlEditor/>
      <extranetConsent/>
      <extranetAccess/>
      <extranetConsentDatetime/>
      <groups/>
      <extensibleUserObjectContent/>
      <sections/>
      <userChannels/>
      <locale/>
      <fullName/>
      <deleted/>
      <powerUser/>
      <administrator/>
      <authLevel/>
      <fullTinyMCELocaleCode/>
      <appliedPreviewChannel/>
      <propertyResourceBundle/>
      <fullLocaleCode/>
    </user>
  </modified>
  <order>0</order>
  <valid>true</valid>
  <key>string</key>
  <validatedInfo>
    <licencee>
      <companyName/>
      <registeredOffice/>
      <territory/>
      <companyStatus/>
    </licencee>
    <licenceContact>
      <salutation/>
      <firstname/>
      <lastname/>
      <email/>
      <legalSalutation/>
      <legalFirstname/>
      <legalLastname/>
    </licenceContact>
    <partnerDetails>
      <name/>
      <partnerSalutation/>
      <partnerFirstname/>
      <partnerLastname/>
    </partnerDetails>
    <licenceDetails>
      <productLicenced/>
      <begins/>
      <ends/>
      <hostname/>
    </licenceDetails>
    <restrictions>
      <content/>
      <user/>
      <channel/>
      <workflow/>
      <contentType/>
      <language/>
    </restrictions>
  </validatedInfo>
</licence>

Responses

Status Meaning Description Schema
200 OK successful operation LicenceDTO

updateOrder

PUT /licence/{id}/order

Responses

Status Meaning Description Schema
default Default successful operation None

list

Describes operations on Predefined lists.

delete

DELETE /list/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getSharingInformation

GET /list/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

modifySharingInformation

PUT /list/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

get

GET /list/{id}/{language}

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
override query boolean false none

Example responses

200 Response

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "sortType": 0,
  "persistentLanguageOptions": {
    "override": true,
    "type": 0,
    "default": true,
    "id": 0,
    "persistentLanguage": "string"
  },
  "duplicate": true,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "listEntriesWithListSubLists": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "cteWithListsAsElements": [
    {
      "name": "string",
      "description": "string",
      "typeID": 0,
      "type": {},
      "maxSize": 0,
      "compulsory": true,
      "sequence": 0,
      "alias": "string",
      "defaultValue": "string",
      "id": 0,
      "contentType": 0,
      "listId": 0
    }
  ],
  "formsUsingThisList": [
    {
      "formId": 0,
      "elementLabel": "string"
    }
  ],
  "sortingEnabled": true,
  "sharedGroupCount": 0,
  "defaultLanguageSetInAnotherLanguage": true,
  "fullyAccessible": true,
  "listOverriddenInAnotherLanguage": true,
  "id": 0,
  "default": true,
  "entries": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "language": "string",
  "override": true,
  "visible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<predefined-list>
  <key>
    <id>0</id>
    <language>string</language>
  </key>
  <name>string</name>
  <description>string</description>
  <sortType>0</sortType>
  <persistentLanguageOptions>
    <override>true</override>
    <type>0</type>
    <default>true</default>
    <id>0</id>
    <persistentLanguage>string</persistentLanguage>
  </persistentLanguageOptions>
  <duplicate>true</duplicate>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <listEntriesWithListSubLists>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </listEntriesWithListSubLists>
  <cteWithListsAsElements>
    <name>string</name>
    <description>string</description>
    <typeID>0</typeID>
    <type/>
    <maxSize>0</maxSize>
    <compulsory>true</compulsory>
    <sequence>0</sequence>
    <alias>string</alias>
    <defaultValue>string</defaultValue>
    <id>0</id>
    <contentType>0</contentType>
    <listId>0</listId>
  </cteWithListsAsElements>
  <formsUsingThisList>
    <formId>0</formId>
    <elementLabel>string</elementLabel>
  </formsUsingThisList>
  <sortingEnabled>true</sortingEnabled>
  <sharedGroupCount>0</sharedGroupCount>
  <defaultLanguageSetInAnotherLanguage>true</defaultLanguageSetInAnotherLanguage>
  <fullyAccessible>true</fullyAccessible>
  <listOverriddenInAnotherLanguage>true</listOverriddenInAnotherLanguage>
  <id>0</id>
  <default>true</default>
  <entries>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </entries>
  <language>string</language>
  <override>true</override>
  <visible>true</visible>
</predefined-list>

Responses

Status Meaning Description Schema
200 OK successful operation PredefinedListDTO

modify

PUT /list/{id}/{language}

Parameters

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

Example responses

200 Response

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "sortType": 0,
  "persistentLanguageOptions": {
    "override": true,
    "type": 0,
    "default": true,
    "id": 0,
    "persistentLanguage": "string"
  },
  "duplicate": true,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "listEntriesWithListSubLists": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "cteWithListsAsElements": [
    {
      "name": "string",
      "description": "string",
      "typeID": 0,
      "type": {},
      "maxSize": 0,
      "compulsory": true,
      "sequence": 0,
      "alias": "string",
      "defaultValue": "string",
      "id": 0,
      "contentType": 0,
      "listId": 0
    }
  ],
  "formsUsingThisList": [
    {
      "formId": 0,
      "elementLabel": "string"
    }
  ],
  "sortingEnabled": true,
  "sharedGroupCount": 0,
  "defaultLanguageSetInAnotherLanguage": true,
  "fullyAccessible": true,
  "listOverriddenInAnotherLanguage": true,
  "id": 0,
  "default": true,
  "entries": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "language": "string",
  "override": true,
  "visible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<predefined-list>
  <key>
    <id>0</id>
    <language>string</language>
  </key>
  <name>string</name>
  <description>string</description>
  <sortType>0</sortType>
  <persistentLanguageOptions>
    <override>true</override>
    <type>0</type>
    <default>true</default>
    <id>0</id>
    <persistentLanguage>string</persistentLanguage>
  </persistentLanguageOptions>
  <duplicate>true</duplicate>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <listEntriesWithListSubLists>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </listEntriesWithListSubLists>
  <cteWithListsAsElements>
    <name>string</name>
    <description>string</description>
    <typeID>0</typeID>
    <type/>
    <maxSize>0</maxSize>
    <compulsory>true</compulsory>
    <sequence>0</sequence>
    <alias>string</alias>
    <defaultValue>string</defaultValue>
    <id>0</id>
    <contentType>0</contentType>
    <listId>0</listId>
  </cteWithListsAsElements>
  <formsUsingThisList>
    <formId>0</formId>
    <elementLabel>string</elementLabel>
  </formsUsingThisList>
  <sortingEnabled>true</sortingEnabled>
  <sharedGroupCount>0</sharedGroupCount>
  <defaultLanguageSetInAnotherLanguage>true</defaultLanguageSetInAnotherLanguage>
  <fullyAccessible>true</fullyAccessible>
  <listOverriddenInAnotherLanguage>true</listOverriddenInAnotherLanguage>
  <id>0</id>
  <default>true</default>
  <entries>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </entries>
  <language>string</language>
  <override>true</override>
  <visible>true</visible>
</predefined-list>

Responses

Status Meaning Description Schema
200 OK successful operation PredefinedListDTO

getSublists

GET /list/{id}/{language}/sublist

Parameters

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

Example responses

200 Response

[
  {
    "key": {
      "id": 0,
      "language": "string"
    },
    "name": "string",
    "description": "string",
    "language": "string",
    "id": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<key>
  <id>0</id>
  <language>string</language>
</key>
<name>string</name>
<description>string</description>
<language>string</language>
<id>0</id>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getNonAccessControlledList

GET /list/{id}/{language}/unfiltered

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
override query boolean false none
checkFormListUsage query boolean false none

Example responses

200 Response

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "sortType": 0,
  "persistentLanguageOptions": {
    "override": true,
    "type": 0,
    "default": true,
    "id": 0,
    "persistentLanguage": "string"
  },
  "duplicate": true,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "listEntriesWithListSubLists": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "cteWithListsAsElements": [
    {
      "name": "string",
      "description": "string",
      "typeID": 0,
      "type": {},
      "maxSize": 0,
      "compulsory": true,
      "sequence": 0,
      "alias": "string",
      "defaultValue": "string",
      "id": 0,
      "contentType": 0,
      "listId": 0
    }
  ],
  "formsUsingThisList": [
    {
      "formId": 0,
      "elementLabel": "string"
    }
  ],
  "sortingEnabled": true,
  "sharedGroupCount": 0,
  "defaultLanguageSetInAnotherLanguage": true,
  "fullyAccessible": true,
  "listOverriddenInAnotherLanguage": true,
  "id": 0,
  "default": true,
  "entries": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "language": "string",
  "override": true,
  "visible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<predefined-list>
  <key>
    <id>0</id>
    <language>string</language>
  </key>
  <name>string</name>
  <description>string</description>
  <sortType>0</sortType>
  <persistentLanguageOptions>
    <override>true</override>
    <type>0</type>
    <default>true</default>
    <id>0</id>
    <persistentLanguage>string</persistentLanguage>
  </persistentLanguageOptions>
  <duplicate>true</duplicate>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <listEntriesWithListSubLists>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </listEntriesWithListSubLists>
  <cteWithListsAsElements>
    <name>string</name>
    <description>string</description>
    <typeID>0</typeID>
    <type/>
    <maxSize>0</maxSize>
    <compulsory>true</compulsory>
    <sequence>0</sequence>
    <alias>string</alias>
    <defaultValue>string</defaultValue>
    <id>0</id>
    <contentType>0</contentType>
    <listId>0</listId>
  </cteWithListsAsElements>
  <formsUsingThisList>
    <formId>0</formId>
    <elementLabel>string</elementLabel>
  </formsUsingThisList>
  <sortingEnabled>true</sortingEnabled>
  <sharedGroupCount>0</sharedGroupCount>
  <defaultLanguageSetInAnotherLanguage>true</defaultLanguageSetInAnotherLanguage>
  <fullyAccessible>true</fullyAccessible>
  <listOverriddenInAnotherLanguage>true</listOverriddenInAnotherLanguage>
  <id>0</id>
  <default>true</default>
  <entries>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </entries>
  <language>string</language>
  <override>true</override>
  <visible>true</visible>
</predefined-list>

Responses

Status Meaning Description Schema
200 OK successful operation PredefinedListDTO

list

GET /list/{language}

Parameters

Name In Type Required Description
language path string true none
pageNumber query integer(int32) false none
pageSize query integer(int32) false none
override query boolean false none

Example responses

200 Response

[
  {
    "key": {
      "id": 0,
      "language": "string"
    },
    "name": "string",
    "description": "string",
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroupCount": 0,
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "listEntriesWithListSubLists": [
      {
        "language": null,
        "name": null,
        "value": null,
        "sequence": null,
        "id": null,
        "selectedByDefault": null,
        "subListID": null,
        "listID": null,
        "subList": null
      }
    ],
    "cteWithListsAsElements": [
      {
        "name": null,
        "description": null,
        "typeID": null,
        "type": null,
        "maxSize": null,
        "compulsory": null,
        "sequence": null,
        "alias": null,
        "defaultValue": null,
        "id": null,
        "contentType": null,
        "listId": null
      }
    ],
    "formsUsingThisList": [
      {
        "formId": null,
        "elementLabel": null
      }
    ],
    "fullyAccessible": true,
    "language": "string",
    "id": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<key>
  <id>0</id>
  <language>string</language>
</key>
<name>string</name>
<description>string</description>
<editable>true</editable>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroupCount>0</sharedGroupCount>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</sharedGroups>
<listEntriesWithListSubLists>
  <language/>
  <name/>
  <value/>
  <sequence/>
  <id/>
  <selectedByDefault/>
  <subListID/>
  <listID/>
  <subList/>
</listEntriesWithListSubLists>
<cteWithListsAsElements>
  <name/>
  <description/>
  <typeID/>
  <type/>
  <maxSize/>
  <compulsory/>
  <sequence/>
  <alias/>
  <defaultValue/>
  <id/>
  <contentType/>
  <listId/>
</cteWithListsAsElements>
<formsUsingThisList>
  <formId/>
  <elementLabel/>
</formsUsingThisList>
<fullyAccessible>true</fullyAccessible>
<language>string</language>
<id>0</id>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PredefinedListMetaDataDTO] false none none
» sharedGroupCount integer(int32) false none none
» sharedGroups [AssetSharingInformation] false none none
» cteWithListsAsElements [ContentTypeElement] false none none
» formsUsingThisList [FormListUsage] false none none

add

POST /list/{language}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "sortType": 0,
  "persistentLanguageOptions": {
    "override": true,
    "type": 0,
    "default": true,
    "id": 0,
    "persistentLanguage": "string"
  },
  "duplicate": true,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "listEntriesWithListSubLists": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "cteWithListsAsElements": [
    {
      "name": "string",
      "description": "string",
      "typeID": 0,
      "type": {},
      "maxSize": 0,
      "compulsory": true,
      "sequence": 0,
      "alias": "string",
      "defaultValue": "string",
      "id": 0,
      "contentType": 0,
      "listId": 0
    }
  ],
  "formsUsingThisList": [
    {
      "formId": 0,
      "elementLabel": "string"
    }
  ],
  "sortingEnabled": true,
  "sharedGroupCount": 0,
  "defaultLanguageSetInAnotherLanguage": true,
  "fullyAccessible": true,
  "listOverriddenInAnotherLanguage": true,
  "id": 0,
  "default": true,
  "entries": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "language": "string",
  "override": true,
  "visible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<predefined-list>
  <key>
    <id>0</id>
    <language>string</language>
  </key>
  <name>string</name>
  <description>string</description>
  <sortType>0</sortType>
  <persistentLanguageOptions>
    <override>true</override>
    <type>0</type>
    <default>true</default>
    <id>0</id>
    <persistentLanguage>string</persistentLanguage>
  </persistentLanguageOptions>
  <duplicate>true</duplicate>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <listEntriesWithListSubLists>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </listEntriesWithListSubLists>
  <cteWithListsAsElements>
    <name>string</name>
    <description>string</description>
    <typeID>0</typeID>
    <type/>
    <maxSize>0</maxSize>
    <compulsory>true</compulsory>
    <sequence>0</sequence>
    <alias>string</alias>
    <defaultValue>string</defaultValue>
    <id>0</id>
    <contentType>0</contentType>
    <listId>0</listId>
  </cteWithListsAsElements>
  <formsUsingThisList>
    <formId>0</formId>
    <elementLabel>string</elementLabel>
  </formsUsingThisList>
  <sortingEnabled>true</sortingEnabled>
  <sharedGroupCount>0</sharedGroupCount>
  <defaultLanguageSetInAnotherLanguage>true</defaultLanguageSetInAnotherLanguage>
  <fullyAccessible>true</fullyAccessible>
  <listOverriddenInAnotherLanguage>true</listOverriddenInAnotherLanguage>
  <id>0</id>
  <default>true</default>
  <entries>
    <language>string</language>
    <name>string</name>
    <value>string</value>
    <sequence>0</sequence>
    <id>0</id>
    <selectedByDefault>true</selectedByDefault>
    <subListID>0</subListID>
    <listID>0</listID>
    <subList/>
  </entries>
  <language>string</language>
  <override>true</override>
  <visible>true</visible>
</predefined-list>

Responses

Status Meaning Description Schema
200 OK successful operation PredefinedListDTO

listUnfiltered

GET /list/{language}/unfiltered

Parameters

Name In Type Required Description
language path string true none
pageNumber query integer(int32) false none
pageSize query integer(int32) false none
override query boolean false none

Example responses

200 Response

[
  {
    "key": {
      "id": 0,
      "language": "string"
    },
    "name": "string",
    "description": "string",
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroupCount": 0,
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "listEntriesWithListSubLists": [
      {
        "language": null,
        "name": null,
        "value": null,
        "sequence": null,
        "id": null,
        "selectedByDefault": null,
        "subListID": null,
        "listID": null,
        "subList": null
      }
    ],
    "cteWithListsAsElements": [
      {
        "name": null,
        "description": null,
        "typeID": null,
        "type": null,
        "maxSize": null,
        "compulsory": null,
        "sequence": null,
        "alias": null,
        "defaultValue": null,
        "id": null,
        "contentType": null,
        "listId": null
      }
    ],
    "formsUsingThisList": [
      {
        "formId": null,
        "elementLabel": null
      }
    ],
    "fullyAccessible": true,
    "language": "string",
    "id": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<key>
  <id>0</id>
  <language>string</language>
</key>
<name>string</name>
<description>string</description>
<editable>true</editable>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroupCount>0</sharedGroupCount>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</sharedGroups>
<listEntriesWithListSubLists>
  <language/>
  <name/>
  <value/>
  <sequence/>
  <id/>
  <selectedByDefault/>
  <subListID/>
  <listID/>
  <subList/>
</listEntriesWithListSubLists>
<cteWithListsAsElements>
  <name/>
  <description/>
  <typeID/>
  <type/>
  <maxSize/>
  <compulsory/>
  <sequence/>
  <alias/>
  <defaultValue/>
  <id/>
  <contentType/>
  <listId/>
</cteWithListsAsElements>
<formsUsingThisList>
  <formId/>
  <elementLabel/>
</formsUsingThisList>
<fullyAccessible>true</fullyAccessible>
<language>string</language>
<id>0</id>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PredefinedListMetaDataDTO] false none none
» sharedGroupCount integer(int32) false none none
» sharedGroups [AssetSharingInformation] false none none
» cteWithListsAsElements [ContentTypeElement] false none none
» formsUsingThisList [FormListUsage] false none none

lock

These endpoints describe operations on the locking of assets within the TERMINALFOUR system.

isLocked

GET /lock/expired/{id}

Parameters

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

Example responses

200 Response

{
  "assetID": 0,
  "assetType": 0,
  "lockType": 0,
  "expiry": "2019-08-24T14:15:22Z",
  "owner": 0,
  "ownerName": "string",
  "currentUser": true,
  "language": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<assetLock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</assetLock>

Responses

Status Meaning Description Schema
200 OK successful operation AssetLockDTO

getLock

GET /lock/{id}

Parameters

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

Example responses

200 Response

{
  "assetID": 0,
  "assetType": 0,
  "lockType": 0,
  "expiry": "2019-08-24T14:15:22Z",
  "owner": 0,
  "ownerName": "string",
  "currentUser": true,
  "language": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<assetLock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</assetLock>

Responses

Status Meaning Description Schema
200 OK successful operation AssetLockDTO

lock

PUT /lock/{id}

Example responses

200 Response

{
  "assetID": 0,
  "assetType": 0,
  "lockType": 0,
  "expiry": "2019-08-24T14:15:22Z",
  "owner": 0,
  "ownerName": "string",
  "currentUser": true,
  "language": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<assetLock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</assetLock>

Responses

Status Meaning Description Schema
200 OK successful operation AssetLockDTO

unlock

DELETE /lock/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getLockWithTypeSpecified

GET /lock/{id}/{assetType}

Parameters

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

Example responses

200 Response

{
  "assetID": 0,
  "assetType": 0,
  "lockType": 0,
  "expiry": "2019-08-24T14:15:22Z",
  "owner": 0,
  "ownerName": "string",
  "currentUser": true,
  "language": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<assetLock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</assetLock>

Responses

Status Meaning Description Schema
200 OK successful operation AssetLockDTO

lockWithTypeSpecified

PUT /lock/{id}/{assetType}

Example responses

200 Response

{
  "assetID": 0,
  "assetType": 0,
  "lockType": 0,
  "expiry": "2019-08-24T14:15:22Z",
  "owner": 0,
  "ownerName": "string",
  "currentUser": true,
  "language": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<assetLock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</assetLock>

Responses

Status Meaning Description Schema
200 OK successful operation AssetLockDTO

unlockWithTypeSpecified

DELETE /lock/{id}/{assetType}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

log

These endpoints describe getting the system logs from the TERMINALFOUR system.

get

GET /log/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "description": "string",
  "occurred": "2019-08-24T14:15:22Z",
  "severity": "string",
  "eventType": "string",
  "action": "string",
  "error": "string",
  "remoteAddress": "string",
  "language": "string",
  "content": "string",
  "section": "string",
  "user": "string",
  "stackTrace": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<TerminalfourLogDto>
  <id>0</id>
  <description>string</description>
  <occurred>2019-08-24T14:15:22Z</occurred>
  <severity>string</severity>
  <eventType>string</eventType>
  <action>string</action>
  <error>string</error>
  <remoteAddress>string</remoteAddress>
  <language>string</language>
  <content>string</content>
  <section>string</section>
  <user>string</user>
  <stackTrace>string</stackTrace>
</TerminalfourLogDto>

Responses

Status Meaning Description Schema
200 OK successful operation TerminalfourLogDto

mailout

These endpoints describe the web service endpoints for interacting with the TERMINALFOUR mailout service.

parseRecipients

GET /mailout/parse

Parameters

Name In Type Required Description
q query string false none

Example responses

200 Response

[
  {
    "type": "string",
    "id": 0,
    "level": "string",
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<type>string</type>
<id>0</id>
<level>string</level>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getRecipients

GET /mailout/recipient

Parameters

Name In Type Required Description
q query string false none

Example responses

200 Response

[
  {
    "type": "string",
    "id": 0,
    "level": "string",
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<type>string</type>
<id>0</id>
<level>string</level>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

sendMail

POST /mailout/sendMail

Responses

Status Meaning Description Schema
default Default successful operation None

media

These endpoints provide the functionality to interact with Media in the TERMINALFOUR system.

add

POST /media

Example responses

200 Response

0

Responses

Status Meaning Description Schema
200 OK successful operation integer

deleteMultiple

POST /media/category/bulkDelete

Responses

Status Meaning Description Schema
default Default successful operation None

deleteSingle

DELETE /media/category/{categoryID}/id/{id}/{language}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

modify

POST /media/category/{categoryID}/{id}/{language}

Responses

Status Meaning Description Schema
default Default successful operation None

list

POST /media/category/{categoryID}/{language}/list

Parameters

Name In Type Required Description
categoryID path integer(int32) true none
language path string true none
showPending query boolean false none
showUntranslated query boolean false none

Example responses

200 Response

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "accessLevel": 0,
  "mediaRows": [
    {
      "id": 0,
      "status": 0,
      "language": "string",
      "name": "string",
      "description": "string",
      "version": "string",
      "fileName": "string",
      "fileSize": 0,
      "mediaTypeName": "string",
      "thumbnailURL": "string",
      "binaryLanguage": "string",
      "lock": {},
      "numberOfVariants": 0,
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<MediaItemTableData>
  <draw>0</draw>
  <recordsTotal>0</recordsTotal>
  <recordsFiltered>0</recordsFiltered>
  <accessLevel>0</accessLevel>
  <mediaRows>
    <id>0</id>
    <status>0</status>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <version>string</version>
    <fileName>string</fileName>
    <fileSize>0</fileSize>
    <mediaTypeName>string</mediaTypeName>
    <thumbnailURL>string</thumbnailURL>
    <binaryLanguage>string</binaryLanguage>
    <lock/>
    <numberOfVariants>0</numberOfVariants>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
  </mediaRows>
</MediaItemTableData>

Responses

Status Meaning Description Schema
200 OK successful operation MediaItemTableData

getSystemMediaConfigOptions

GET /media/config/options

Example responses

200 Response

{
  "options": [
    {
      "name": "string",
      "type": "string",
      "value": {},
      "valueList": [
        null
      ],
      "valueMap": [
        null
      ]
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<ConfigurationOptions>
  <options>
    <name>string</name>
    <type>string</type>
    <value/>
    <valueList/>
    <valueMap/>
  </options>
</ConfigurationOptions>

Responses

Status Meaning Description Schema
200 OK successful operation ConfigurationOptions

bulkGetMediaUsage

POST /media/getUsage/{language}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

[
  {
    "contentName": "string",
    "assetType": "string",
    "variant": "string",
    "location": "string",
    "occurrences": 0,
    "language": "string",
    "contentID": 0,
    "sectionID": 0,
    "hasAccess": true,
    "contentLayoutContentTypeID": 0,
    "mediaID": 0,
    "variantUsage": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<contentName>string</contentName>
<assetType>string</assetType>
<variant>string</variant>
<location>string</location>
<occurrences>0</occurrences>
<language>string</language>
<contentID>0</contentID>
<sectionID>0</sectionID>
<hasAccess>true</hasAccess>
<contentLayoutContentTypeID>0</contentLayoutContentTypeID>
<mediaID>0</mediaID>
<variantUsage>true</variantUsage>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getMediaHTML

GET /media/html/{media}/{language}/{layout}

Parameters

Name In Type Required Description
media path integer(int32) true none
language path string true none
layout path string true none
attributes query string false none
prepareForEditor query boolean false none

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK successful operation string

getMediaLayoutAttributes

GET /media/layout/attributes/{media}/{language}/{layout}

Parameters

Name In Type Required Description
media path integer(int32) true none
language path string true none
layout path string true none

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

get

GET /media/{id}/{language}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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
  ],
  "syntax": 0,
  "type": 0,
  "binaryLanguage": "string",
  "categories": [
    0
  ],
  "versions": [
    {
      "owner": "string",
      "lastModified": "string",
      "lastModifiedBy": "string",
      "name": "string",
      "version": "string",
      "previousVersion": "string"
    }
  ],
  "keywords": "string",
  "description": "string",
  "typeName": "string",
  "mediaURL": "string",
  "thumbnailURL": "string",
  "mediaPath": "string",
  "mediaSize": 0,
  "fileName": "string",
  "text": "string",
  "variant": 0,
  "variantsAllowed": true,
  "variantName": "string",
  "variantDimensions": "string",
  "accessLevel": 0,
  "locked": true,
  "sectionIDs": [
    0
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<content>
  <id>0</id>
  <contentTypeID>0</contentTypeID>
  <archiveSection>0</archiveSection>
  <publishDate>2019-08-24T14:15:22Z</publishDate>
  <reviewDate>2019-08-24T14:15:22Z</reviewDate>
  <expiryDate>2019-08-24T14:15:22Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-08-24T14:15:22Z</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-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <contentTypeAccess>0</contentTypeAccess>
  <contentTypeLock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </contentTypeLock>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel/>
      <group/>
      <assetID/>
      <groupID/>
      <assetType/>
      <readLevel/>
      <groupName/>
    </primaryGroup>
    <sharedGroups/>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements/>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </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>
  <syntax>0</syntax>
  <type>0</type>
  <binaryLanguage>string</binaryLanguage>
  <categories>0</categories>
  <versions>
    <owner>string</owner>
    <lastModified>string</lastModified>
    <lastModifiedBy>string</lastModifiedBy>
    <name>string</name>
    <version>string</version>
    <previousVersion>string</previousVersion>
  </versions>
  <keywords>string</keywords>
  <description>string</description>
  <typeName>string</typeName>
  <mediaURL>string</mediaURL>
  <thumbnailURL>string</thumbnailURL>
  <mediaPath>string</mediaPath>
  <mediaSize>0</mediaSize>
  <fileName>string</fileName>
  <text>string</text>
  <variant>0</variant>
  <variantsAllowed>true</variantsAllowed>
  <variantName>string</variantName>
  <variantDimensions>string</variantDimensions>
  <accessLevel>0</accessLevel>
  <locked>true</locked>
  <sectionIDs>0</sectionIDs>
</content>

Responses

Status Meaning Description Schema
200 OK successful operation MediaDTO

getMediaUsage

GET /media/{id}/{language}/usage

Parameters

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

Example responses

200 Response

[
  {
    "contentName": "string",
    "assetType": "string",
    "variant": "string",
    "location": "string",
    "occurrences": 0,
    "language": "string",
    "contentID": 0,
    "sectionID": 0,
    "hasAccess": true,
    "contentLayoutContentTypeID": 0,
    "mediaID": 0,
    "variantUsage": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<contentName>string</contentName>
<assetType>string</assetType>
<variant>string</variant>
<location>string</location>
<occurrences>0</occurrences>
<language>string</language>
<contentID>0</contentID>
<sectionID>0</sectionID>
<hasAccess>true</hasAccess>
<contentLayoutContentTypeID>0</contentLayoutContentTypeID>
<mediaID>0</mediaID>
<variantUsage>true</variantUsage>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

addCropVariant

POST /media/{id}/{language}/variant/crop

Parameters

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

Example responses

200 Response

0

Responses

Status Meaning Description Schema
200 OK successful operation integer

modifyCropVariant

PUT /media/{id}/{language}/variant/crop/modify

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

listVariants

GET /media/{id}/{language}/variant/list

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "parentID": 0,
    "type": 0,
    "thumbnailURL": "string",
    "dimensions": [
      0
    ],
    "variantName": "string",
    "variantDimensions": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<language>string</language>
<name>string</name>
<description>string</description>
<parentID>0</parentID>
<type>0</type>
<thumbnailURL>string</thumbnailURL>
<dimensions>0</dimensions>
<variantName>string</variantName>
<variantDimensions>string</variantDimensions>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

addResizeVariant

POST /media/{id}/{language}/variant/resize

Parameters

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

Example responses

200 Response

0

Responses

Status Meaning Description Schema
200 OK successful operation integer

modifyResizeVariant

PUT /media/{id}/{language}/variant/resize/modify

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getMediaVersions

GET /media/{id}/{language}/versions

Parameters

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

Example responses

200 Response

[
  {
    "owner": "string",
    "lastModified": "string",
    "lastModifiedBy": "string",
    "name": "string",
    "version": "string",
    "previousVersion": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<owner>string</owner>
<lastModified>string</lastModified>
<lastModifiedBy>string</lastModifiedBy>
<name>string</name>
<version>string</version>
<previousVersion>string</previousVersion>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

downloadSingle

GET /media/{id}/{language}/{version}/{element}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

downloadMultiple

GET /media/{language}/{element}/{ids}

Parameters

Name In Type Required Description
ids path string true none
language path string true none
element path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

mediacategory

These endpoints describe the web services for interacting with Media categories in the TERMINALFOUR system.

list

POST /mediacategory

Example responses

200 Response

[
  {
    "id": 0,
    "language": "string",
    "name": "string",
    "accessLevel": 0,
    "status": 0,
    "children": [
      {
        "id": null,
        "language": null,
        "name": null,
        "accessLevel": null,
        "status": null,
        "children": null,
        "lastModified": null,
        "printSequence": null,
        "open": null
      }
    ],
    "lastModified": "2019-08-24T14:15:22Z",
    "printSequence": 0,
    "open": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<language>string</language>
<name>string</name>
<accessLevel>0</accessLevel>
<status>0</status>
<children>
  <id/>
  <language/>
  <name/>
  <accessLevel/>
  <status/>
  <children/>
  <lastModified/>
  <printSequence/>
  <open/>
</children>
<lastModified>2019-08-24T14:15:22Z</lastModified>
<printSequence>0</printSequence>
<open>true</open>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

delete

DELETE /mediacategory/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /mediacategory/{id}/{language}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "accessLevel": 0,
  "categoryReadRestricted": true,
  "mediaCategoryPublishRuleDTOs": [
    {
      "channelID": 0,
      "mediaTypeID": 0,
      "publishRuleID": 0,
      "categoryID": 0
    }
  ],
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<MediaCategorySectionDTO>
  <id>0</id>
  <parent>0</parent>
  <name>string</name>
  <description>string</description>
  <outputUrl>string</outputUrl>
  <outputFilename>string</outputFilename>
  <accessKey>string</accessKey>
  <keyPhrase>string</keyPhrase>
  <status>0</status>
  <workflow>0</workflow>
  <parentWorkflowName>string</parentWorkflowName>
  <show>true</show>
  <iseForm>true</iseForm>
  <archive>true</archive>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <printSequence>0</printSequence>
  <contentSortMethod>0</contentSortMethod>
  <sectionSortMethod>0</sectionSortMethod>
  <path>string</path>
  <mirrorOf>0</mirrorOf>
  <sourceOfMirror>true</sourceOfMirror>
  <link>true</link>
  <channels>
    <id>0</id>
    <pageLayout>0</pageLayout>
    <inheritedPageLayout>0</inheritedPageLayout>
    <valid>true</valid>
  </channels>
  <userIDs>0</userIDs>
  <inheritedUserIDs>0</inheritedUserIDs>
  <groupIDs>0</groupIDs>
  <inheritedGroupIDs>0</inheritedGroupIDs>
  <viewUserIDs>0</viewUserIDs>
  <viewGroupIDs>0</viewGroupIDs>
  <contentTypeScopes>
    <id>0</id>
    <scope>0</scope>
    <inherited>true</inherited>
  </contentTypeScopes>
  <metaDatas>
    <id>0</id>
    <value>string</value>
    <lang>string</lang>
  </metaDatas>
  <linkInfo>
    <type>0</type>
    <section>0</section>
    <url>string</url>
    <language>string</language>
    <target>string</target>
    <accessControl>0</accessControl>
    <override>true</override>
    <overridden>true</overridden>
  </linkInfo>
  <excludedMirrorSections>0</excludedMirrorSections>
  <workflowName>string</workflowName>
  <parentWorkflowID>0</parentWorkflowID>
  <accessControl>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </accessControl>
  <metaData>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </metaData>
  <pathMembers>0</pathMembers>
  <sortLock>TOP</sortLock>
  <editable>true</editable>
  <inheritedLinkSection>true</inheritedLinkSection>
  <accessControlEnabled>true</accessControlEnabled>
  <accessControlType>0</accessControlType>
  <metaDataType>0</metaDataType>
  <accessControlInherited>true</accessControlInherited>
  <allowedGroups>0</allowedGroups>
  <mirrorOfPath>string</mirrorOfPath>
  <inheritedPageLayouts>
    <property1>0</property1>
    <property2>0</property2>
  </inheritedPageLayouts>
  <accessLevel>0</accessLevel>
  <categoryReadRestricted>true</categoryReadRestricted>
  <mediaCategoryPublishRuleDTOs>
    <channelID>0</channelID>
    <mediaTypeID>0</mediaTypeID>
    <publishRuleID>0</publishRuleID>
    <categoryID>0</categoryID>
  </mediaCategoryPublishRuleDTOs>
  <outputUriEnabled>true</outputUriEnabled>
  <publishEnabled>true</publishEnabled>
  <outputFilenameEnabled>true</outputFilenameEnabled>
  <spellCheckEnabled>true</spellCheckEnabled>
  <pathAsOutputUriEnabled>true</pathAsOutputUriEnabled>
</MediaCategorySectionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MediaCategorySectionDTO

update

PUT /mediacategory/{id}/{language}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

add

POST /mediacategory/{language}

Parameters

Name In Type Required Description
language path string true none

Example responses

200 Response

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "accessLevel": 0,
  "categoryReadRestricted": true,
  "mediaCategoryPublishRuleDTOs": [
    {
      "channelID": 0,
      "mediaTypeID": 0,
      "publishRuleID": 0,
      "categoryID": 0
    }
  ],
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<MediaCategorySectionDTO>
  <id>0</id>
  <parent>0</parent>
  <name>string</name>
  <description>string</description>
  <outputUrl>string</outputUrl>
  <outputFilename>string</outputFilename>
  <accessKey>string</accessKey>
  <keyPhrase>string</keyPhrase>
  <status>0</status>
  <workflow>0</workflow>
  <parentWorkflowName>string</parentWorkflowName>
  <show>true</show>
  <iseForm>true</iseForm>
  <archive>true</archive>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <printSequence>0</printSequence>
  <contentSortMethod>0</contentSortMethod>
  <sectionSortMethod>0</sectionSortMethod>
  <path>string</path>
  <mirrorOf>0</mirrorOf>
  <sourceOfMirror>true</sourceOfMirror>
  <link>true</link>
  <channels>
    <id>0</id>
    <pageLayout>0</pageLayout>
    <inheritedPageLayout>0</inheritedPageLayout>
    <valid>true</valid>
  </channels>
  <userIDs>0</userIDs>
  <inheritedUserIDs>0</inheritedUserIDs>
  <groupIDs>0</groupIDs>
  <inheritedGroupIDs>0</inheritedGroupIDs>
  <viewUserIDs>0</viewUserIDs>
  <viewGroupIDs>0</viewGroupIDs>
  <contentTypeScopes>
    <id>0</id>
    <scope>0</scope>
    <inherited>true</inherited>
  </contentTypeScopes>
  <metaDatas>
    <id>0</id>
    <value>string</value>
    <lang>string</lang>
  </metaDatas>
  <linkInfo>
    <type>0</type>
    <section>0</section>
    <url>string</url>
    <language>string</language>
    <target>string</target>
    <accessControl>0</accessControl>
    <override>true</override>
    <overridden>true</overridden>
  </linkInfo>
  <excludedMirrorSections>0</excludedMirrorSections>
  <workflowName>string</workflowName>
  <parentWorkflowID>0</parentWorkflowID>
  <accessControl>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </accessControl>
  <metaData>
    <id>0</id>
    <type>0</type>
    <enabled>true</enabled>
    <active>true</active>
  </metaData>
  <pathMembers>0</pathMembers>
  <sortLock>TOP</sortLock>
  <editable>true</editable>
  <inheritedLinkSection>true</inheritedLinkSection>
  <accessControlEnabled>true</accessControlEnabled>
  <accessControlType>0</accessControlType>
  <metaDataType>0</metaDataType>
  <accessControlInherited>true</accessControlInherited>
  <allowedGroups>0</allowedGroups>
  <mirrorOfPath>string</mirrorOfPath>
  <inheritedPageLayouts>
    <property1>0</property1>
    <property2>0</property2>
  </inheritedPageLayouts>
  <accessLevel>0</accessLevel>
  <categoryReadRestricted>true</categoryReadRestricted>
  <mediaCategoryPublishRuleDTOs>
    <channelID>0</channelID>
    <mediaTypeID>0</mediaTypeID>
    <publishRuleID>0</publishRuleID>
    <categoryID>0</categoryID>
  </mediaCategoryPublishRuleDTOs>
  <outputUriEnabled>true</outputUriEnabled>
  <publishEnabled>true</publishEnabled>
  <outputFilenameEnabled>true</outputFilenameEnabled>
  <spellCheckEnabled>true</spellCheckEnabled>
  <pathAsOutputUriEnabled>true</pathAsOutputUriEnabled>
</MediaCategorySectionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MediaCategorySectionDTO

mediaformat

These endpoints describe interacting with media layouts in the TERMINALFOUR system.

list

GET /mediaformat

Example responses

200 Response

[
  {
    "mediaTypeID": 0,
    "mediaLayout": "string",
    "defaultMediaFormat": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<mediaTypeID>0</mediaTypeID>
<mediaLayout>string</mediaLayout>
<defaultMediaFormat>true</defaultMediaFormat>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /mediaformat/{media}/{language}

Parameters

Name In Type Required Description
media path integer(int32) true none
language path string true none

Example responses

200 Response

[
  {
    "mediaTypeID": 0,
    "mediaLayout": "string",
    "defaultMediaFormat": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<mediaTypeID>0</mediaTypeID>
<mediaLayout>string</mediaLayout>
<defaultMediaFormat>true</defaultMediaFormat>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

mediaType

These endpoints provide the functionality for interacting with the Media Types used in the TERMINALFOUR system.

list

GET /mediaType

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "permittedExtensions": "string",
    "maxSize": 0,
    "formats": [
      {
        "mediaTypeID": null,
        "mediaLayout": null,
        "default": null
      }
    ],
    "defaultFormat": {
      "mediaTypeID": 0,
      "mediaLayout": "string",
      "default": true
    },
    "allFormats": [
      {
        "mediaTypeID": null,
        "mediaLayout": null,
        "default": null
      }
    ],
    "parseForTagsEnabled": true,
    "permittedExtensionsFormatted": [
      "string"
    ],
    "binary": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<permittedExtensions>string</permittedExtensions>
<maxSize>0</maxSize>
<formats>
  <mediaTypeID/>
  <mediaLayout/>
  <default/>
</formats>
<defaultFormat>
  <mediaTypeID>0</mediaTypeID>
  <mediaLayout>string</mediaLayout>
  <default>true</default>
</defaultFormat>
<allFormats>
  <mediaTypeID/>
  <mediaLayout/>
  <default/>
</allFormats>
<parseForTagsEnabled>true</parseForTagsEnabled>
<permittedExtensionsFormatted>string</permittedExtensionsFormatted>
<binary>true</binary>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /mediaType

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "permittedExtensions": "string",
  "maxSize": 0,
  "formatters": [
    {
      "mediaTypeID": 0,
      "mediaLayout": "string",
      "defaultMediaFormat": true
    }
  ],
  "binaryEnabled": true,
  "parseForTagsEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<MediaTypeDTO>
  <id>0</id>
  <name>string</name>
  <permittedExtensions>string</permittedExtensions>
  <maxSize>0</maxSize>
  <formatters>
    <mediaTypeID>0</mediaTypeID>
    <mediaLayout>string</mediaLayout>
    <defaultMediaFormat>true</defaultMediaFormat>
  </formatters>
  <binaryEnabled>true</binaryEnabled>
  <parseForTagsEnabled>true</parseForTagsEnabled>
</MediaTypeDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MediaTypeDTO

get

GET /mediaType/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "permittedExtensions": "string",
  "maxSize": 0,
  "formatters": [
    {
      "mediaTypeID": 0,
      "mediaLayout": "string",
      "defaultMediaFormat": true
    }
  ],
  "binaryEnabled": true,
  "parseForTagsEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<MediaTypeDTO>
  <id>0</id>
  <name>string</name>
  <permittedExtensions>string</permittedExtensions>
  <maxSize>0</maxSize>
  <formatters>
    <mediaTypeID>0</mediaTypeID>
    <mediaLayout>string</mediaLayout>
    <defaultMediaFormat>true</defaultMediaFormat>
  </formatters>
  <binaryEnabled>true</binaryEnabled>
  <parseForTagsEnabled>true</parseForTagsEnabled>
</MediaTypeDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MediaTypeDTO

update

PUT /mediaType/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

mediavariant

This service describes the endpoints for managing media variants configuration within the TERMINALFOUR system.

list

GET /mediavariant

Example responses

200 Response

[
  {
    "name": "string",
    "width": 0,
    "height": 0,
    "retainAspectRatio": true,
    "newName": "string",
    "modified": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<name>string</name>
<width>0</width>
<height>0</height>
<retainAspectRatio>true</retainAspectRatio>
<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 [MediaVariantDTO] false none none

get

GET /mediavariant/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "name": "string",
  "width": 0,
  "height": 0,
  "retainAspectRatio": true,
  "newName": "string",
  "modified": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<mediaVariant>
  <name>string</name>
  <width>0</width>
  <height>0</height>
  <retainAspectRatio>true</retainAspectRatio>
  <newName>string</newName>
  <modified>true</modified>
</mediaVariant>

Responses

Status Meaning Description Schema
200 OK successful operation MediaVariantDTO

addOrModify

PUT /mediavariant/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "name": "string",
  "width": 0,
  "height": 0,
  "retainAspectRatio": true,
  "newName": "string",
  "modified": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<mediaVariant>
  <name>string</name>
  <width>0</width>
  <height>0</height>
  <retainAspectRatio>true</retainAspectRatio>
  <newName>string</newName>
  <modified>true</modified>
</mediaVariant>

Responses

Status Meaning Description Schema
200 OK successful operation MediaVariantDTO

delete

DELETE /mediavariant/{name}

Parameters

Name In Type Required Description
name path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

mediaxhrnotsupported

A web service for uploading files from old browsers that do not support XHR requests.

create

POST /media/xhrnotsupported/create

Responses

Status Meaning Description Schema
default Default successful operation None

modify

POST /media/xhrnotsupported/modify

Responses

Status Meaning Description Schema
default Default successful operation None

update

POST /media/xhrnotsupported/update

Responses

Status Meaning Description Schema
default Default successful operation None

medium

These endpoints provide the functionality for interacting with the Mediums in the TERMINALFOUR system.

list

GET /medium

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "path": "string",
    "enabled": true,
    "type": 0,
    "className": "string",
    "username": "string",
    "password": "string",
    "tlsEncryptionType": "string",
    "tlsPort": "string",
    "serverType": 0,
    "secondary": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<path>string</path>
<enabled>true</enabled>
<type>0</type>
<className>string</className>
<username>string</username>
<password>string</password>
<tlsEncryptionType>string</tlsEncryptionType>
<tlsPort>string</tlsPort>
<serverType>0</serverType>
<secondary>0</secondary>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /medium

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "path": "string",
  "enabled": true,
  "type": 0,
  "className": "string",
  "username": "string",
  "password": "string",
  "tlsEncryptionType": "string",
  "tlsPort": "string",
  "serverType": 0,
  "secondary": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<MediumDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <path>string</path>
  <enabled>true</enabled>
  <type>0</type>
  <className>string</className>
  <username>string</username>
  <password>string</password>
  <tlsEncryptionType>string</tlsEncryptionType>
  <tlsPort>string</tlsPort>
  <serverType>0</serverType>
  <secondary>0</secondary>
</MediumDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MediumDTO

get

GET /medium/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "path": "string",
  "enabled": true,
  "type": 0,
  "className": "string",
  "username": "string",
  "password": "string",
  "tlsEncryptionType": "string",
  "tlsPort": "string",
  "serverType": 0,
  "secondary": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<MediumDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <path>string</path>
  <enabled>true</enabled>
  <type>0</type>
  <className>string</className>
  <username>string</username>
  <password>string</password>
  <tlsEncryptionType>string</tlsEncryptionType>
  <tlsPort>string</tlsPort>
  <serverType>0</serverType>
  <secondary>0</secondary>
</MediumDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MediumDTO

update

PUT /medium/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /medium/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

menu

Provides information on the menu for client side navigation in the front end.

get

GET /menu

Example responses

200 Response

{
  "id": 0,
  "ordinal": 0,
  "title": "string",
  "icon": "string",
  "href": "string",
  "subMenus": [
    {
      "id": 0,
      "ordinal": 0,
      "title": "string",
      "icon": "string",
      "href": "string",
      "subMenus": [
        null
      ]
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<MenuDTO>
  <id>0</id>
  <ordinal>0</ordinal>
  <title>string</title>
  <icon>string</icon>
  <href>string</href>
  <subMenus>
    <id>0</id>
    <ordinal>0</ordinal>
    <title>string</title>
    <icon>string</icon>
    <href>string</href>
    <subMenus/>
  </subMenus>
</MenuDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MenuDTO

meta

These endpoints provide the functionality to interact with the meta tags in the TERMINALFOUR system.

list

GET /meta/level

Parameters

Name In Type Required Description
level path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "setting": 0,
    "language": "string",
    "format": "string",
    "specialMapping": 0,
    "metaAttribute": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<setting>0</setting>
<language>string</language>
<format>string</format>
<specialMapping>0</specialMapping>
<metaAttribute>0</metaAttribute>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

save

PUT /meta

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "setting": 0,
    "language": "string",
    "format": "string",
    "specialMapping": 0,
    "metaAttribute": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<setting>0</setting>
<language>string</language>
<format>string</format>
<specialMapping>0</specialMapping>
<metaAttribute>0</metaAttribute>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /meta/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "setting": 0,
  "language": "string",
  "format": "string",
  "specialMapping": 0,
  "metaAttribute": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<MetaTagDTO>
  <id>0</id>
  <name>string</name>
  <setting>0</setting>
  <language>string</language>
  <format>string</format>
  <specialMapping>0</specialMapping>
  <metaAttribute>0</metaAttribute>
</MetaTagDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MetaTagDTO

delete

DELETE /meta/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

metainfo

These endpoints describe operations on mapping content types to meta tags in the TERMINALFOUR system.

save

PUT /metainfo

Example responses

200 Response

[
  {
    "contentTypeID": 0,
    "elementID": 0,
    "metaIDs": [
      0
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<contentTypeID>0</contentTypeID>
<elementID>0</elementID>
<metaIDs>0</metaIDs>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

list

GET /metainfo/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

[
  {
    "contentTypeID": 0,
    "elementID": 0,
    "metaIDs": [
      0
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<contentTypeID>0</contentTypeID>
<elementID>0</elementID>
<metaIDs>0</metaIDs>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

navigation

These endpoints provide the functionality for interacting with the navigation objects in the TERMINALFOUR system.

list

GET /navigation

Example responses

200 Response

[
  {
    "id": 0,
    "sharedGroupCount": 0,
    "name": "string",
    "description": "string",
    "navigationType": "string",
    "navigationTypeName": "string",
    "editable": true,
    "enable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "deprecated": true,
    "deprecationCode": "string",
    "fullyAccessible": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<sharedGroupCount>0</sharedGroupCount>
<name>string</name>
<description>string</description>
<navigationType>string</navigationType>
<navigationTypeName>string</navigationTypeName>
<editable>true</editable>
<enable>true</enable>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</sharedGroups>
<deprecated>true</deprecated>
<deprecationCode>string</deprecationCode>
<fullyAccessible>true</fullyAccessible>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NavigationMetaDataDTO] false none none
» sharedGroups [AssetSharingInformation] false none none

add

POST /navigation

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "navigationType": "string",
  "navigationKey": "string",
  "frontEndFileName": "string",
  "description": "string",
  "date": "string",
  "sharedGroupCount": 0,
  "editable": true,
  "enabled": true,
  "previewMode": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "properties": {
    "property1": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    },
    "property2": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    }
  },
  "fullyAccessible": true,
  "xhtmlcompliant": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<navigation>
  <id>0</id>
  <name>string</name>
  <navigationType>string</navigationType>
  <navigationKey>string</navigationKey>
  <frontEndFileName>string</frontEndFileName>
  <description>string</description>
  <date>string</date>
  <sharedGroupCount>0</sharedGroupCount>
  <editable>true</editable>
  <enabled>true</enabled>
  <previewMode>true</previewMode>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <properties>
    <property1>
      <value>string</value>
      <attribute>string</attribute>
      <navigationPropertyID>0</navigationPropertyID>
      <navigation/>
    </property1>
    <property2>
      <value>string</value>
      <attribute>string</attribute>
      <navigationPropertyID>0</navigationPropertyID>
      <navigation/>
    </property2>
  </properties>
  <fullyAccessible>true</fullyAccessible>
  <xhtmlcompliant>true</xhtmlcompliant>
</navigation>

Responses

Status Meaning Description Schema
200 OK successful operation NavigationDTO

listEnabledNavigationTypes

GET /navigation/items

Example responses

200 Response

[
  {
    "name": "string",
    "description": "string",
    "key": "string",
    "type": "string",
    "supportsCaching": true,
    "frontEndFileName": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<name>string</name>
<description>string</description>
<key>string</key>
<type>string</type>
<supportsCaching>true</supportsCaching>
<frontEndFileName>string</frontEndFileName>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /navigation/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "navigationType": "string",
  "navigationKey": "string",
  "frontEndFileName": "string",
  "description": "string",
  "date": "string",
  "sharedGroupCount": 0,
  "editable": true,
  "enabled": true,
  "previewMode": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "properties": {
    "property1": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    },
    "property2": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    }
  },
  "fullyAccessible": true,
  "xhtmlcompliant": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<navigation>
  <id>0</id>
  <name>string</name>
  <navigationType>string</navigationType>
  <navigationKey>string</navigationKey>
  <frontEndFileName>string</frontEndFileName>
  <description>string</description>
  <date>string</date>
  <sharedGroupCount>0</sharedGroupCount>
  <editable>true</editable>
  <enabled>true</enabled>
  <previewMode>true</previewMode>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <properties>
    <property1>
      <value>string</value>
      <attribute>string</attribute>
      <navigationPropertyID>0</navigationPropertyID>
      <navigation/>
    </property1>
    <property2>
      <value>string</value>
      <attribute>string</attribute>
      <navigationPropertyID>0</navigationPropertyID>
      <navigation/>
    </property2>
  </properties>
  <fullyAccessible>true</fullyAccessible>
  <xhtmlcompliant>true</xhtmlcompliant>
</navigation>

Responses

Status Meaning Description Schema
200 OK successful operation NavigationDTO

modify

PUT /navigation/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "navigationType": "string",
  "navigationKey": "string",
  "frontEndFileName": "string",
  "description": "string",
  "date": "string",
  "sharedGroupCount": 0,
  "editable": true,
  "enabled": true,
  "previewMode": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "properties": {
    "property1": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    },
    "property2": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    }
  },
  "fullyAccessible": true,
  "xhtmlcompliant": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<navigation>
  <id>0</id>
  <name>string</name>
  <navigationType>string</navigationType>
  <navigationKey>string</navigationKey>
  <frontEndFileName>string</frontEndFileName>
  <description>string</description>
  <date>string</date>
  <sharedGroupCount>0</sharedGroupCount>
  <editable>true</editable>
  <enabled>true</enabled>
  <previewMode>true</previewMode>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <properties>
    <property1>
      <value>string</value>
      <attribute>string</attribute>
      <navigationPropertyID>0</navigationPropertyID>
      <navigation/>
    </property1>
    <property2>
      <value>string</value>
      <attribute>string</attribute>
      <navigationPropertyID>0</navigationPropertyID>
      <navigation/>
    </property2>
  </properties>
  <fullyAccessible>true</fullyAccessible>
  <xhtmlcompliant>true</xhtmlcompliant>
</navigation>

Responses

Status Meaning Description Schema
200 OK successful operation NavigationDTO

delete

DELETE /navigation/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getSharingInformation

GET /navigation/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

modifySharingInformation

PUT /navigation/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

navigationUsage

These endpoints describe the functionality for getting the code snippet for a particular navigation object from a page layout.

getCodeSnippet

GET /navigationUsage/snippet/{pageLayout}/{navigation}/{line}

Parameters

Name In Type Required Description
pageLayout path integer(int32) true none
navigation path integer(int32) true none
line path integer(int32) true none

Example responses

200 Response

{
  "code": "string",
  "markLine": 0,
  "firstLine": 0,
  "firstChar": 0,
  "lastChar": 0,
  "empty": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<CodeSnippet>
  <code>string</code>
  <markLine>0</markLine>
  <firstLine>0</firstLine>
  <firstChar>0</firstChar>
  <lastChar>0</lastChar>
  <empty>true</empty>
</CodeSnippet>

Responses

Status Meaning Description Schema
200 OK successful operation CodeSnippet

notifications

These endpoints provide the functionality to interact with the TERMINALFOUR notifications system.

listNotifications

GET /notifications

Example responses

200 Response

[
  {
    "id": 0,
    "notificationType": "PUBLISH",
    "notificationStatus": "IN_PROGRESS",
    "createdTime": "2019-08-24T14:15:22Z",
    "executionTime": "2019-08-24T14:15:22Z",
    "completionTime": "2019-08-24T14:15:22Z",
    "properties": {
      "property1": "string",
      "property2": "string"
    },
    "userNotificationMappings": [
      {
        "notification": null,
        "user": null
      }
    ],
    "users": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "notificationProperties": {
      "property1": {
        "id": null,
        "propertyKey": null,
        "propertyValue": null
      },
      "property2": {
        "id": null,
        "propertyKey": null,
        "propertyValue": null
      }
    },
    "notificationScheduled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<notificationType>PUBLISH</notificationType>
<notificationStatus>IN_PROGRESS</notificationStatus>
<createdTime>2019-08-24T14:15:22Z</createdTime>
<executionTime>2019-08-24T14:15:22Z</executionTime>
<completionTime>2019-08-24T14:15:22Z</completionTime>
<properties>
  <property1>string</property1>
  <property2>string</property2>
</properties>
<userNotificationMappings>
  <notification/>
  <user/>
</userNotificationMappings>
<users>
  <property1>string</property1>
  <property2>string</property2>
</users>
<notificationProperties>
  <property1>
    <id/>
    <propertyKey/>
    <propertyValue/>
  </property1>
  <property2>
    <id/>
    <propertyKey/>
    <propertyValue/>
  </property2>
</notificationProperties>
<notificationScheduled>true</notificationScheduled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Notification] false none none
»»»»»»»»» priority integer(int32) false none none
»»»»»»»»» disclaimer string false none none
»»»»»»»»» publishRule integer(int32) false none none
»»»»»»» contentVersions object false none none
»»»»»»» languageCount integer(int32) false none none
»»»»»» printSequence integer(int32) false none none
»»»»»» sortLock string false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» entityID integer(int32) false none none
»»»»»» contentID integer(int32) false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» pageLayoutID integer(int32) false none none
»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»» elementForFilename integer(int32) false none none
»»»»»»» alias string false none none
»»»»»»» directEditEnabled boolean false none none
»»»»»»»»» sequence integer(int32) false none none
»»»»»»»» restricted boolean false none none
»»»»»»» duplicate boolean false none none
»»»»»»» type integer(int32) false none none
»»»»»»» sectionID integer(int32) false none none
»»»»»»» minAuthLevel integer(int32) false none none
»»»»»» scope integer(int32) false none none
»»»»»» contentTypeID integer(int32) false none none
»»»»» sortLock string false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
» users [object] false none none
»» additionalProperties string false none none
» notificationProperties object false none none
» notificationScheduled boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

listNotificationsOfType

GET /notifications/{type}/{subType}

Parameters

Name In Type Required Description
type path string true none
subType path string true none

Enumerated Values

Parameter Value
type PUBLISH
type TRANSFER
type CONTENTSYNC
type ACCESSIBILITY
type MEMORYUSAGE
type LDAPIMPORT
type SUBMISSIONIMPORT
type CONTENTTYPEUPDATE
type FORMBUILDERCONNECTION
type OTHER

Example responses

200 Response

[
  {
    "id": 0,
    "notificationType": "PUBLISH",
    "notificationStatus": "IN_PROGRESS",
    "createdTime": "2019-08-24T14:15:22Z",
    "executionTime": "2019-08-24T14:15:22Z",
    "completionTime": "2019-08-24T14:15:22Z",
    "properties": {
      "property1": "string",
      "property2": "string"
    },
    "userNotificationMappings": [
      {
        "notification": null,
        "user": null
      }
    ],
    "users": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "notificationProperties": {
      "property1": {
        "id": null,
        "propertyKey": null,
        "propertyValue": null
      },
      "property2": {
        "id": null,
        "propertyKey": null,
        "propertyValue": null
      }
    },
    "notificationScheduled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<notificationType>PUBLISH</notificationType>
<notificationStatus>IN_PROGRESS</notificationStatus>
<createdTime>2019-08-24T14:15:22Z</createdTime>
<executionTime>2019-08-24T14:15:22Z</executionTime>
<completionTime>2019-08-24T14:15:22Z</completionTime>
<properties>
  <property1>string</property1>
  <property2>string</property2>
</properties>
<userNotificationMappings>
  <notification/>
  <user/>
</userNotificationMappings>
<users>
  <property1>string</property1>
  <property2>string</property2>
</users>
<notificationProperties>
  <property1>
    <id/>
    <propertyKey/>
    <propertyValue/>
  </property1>
  <property2>
    <id/>
    <propertyKey/>
    <propertyValue/>
  </property2>
</notificationProperties>
<notificationScheduled>true</notificationScheduled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Notification] false none none
»»»»»»»»» priority integer(int32) false none none
»»»»»»»»» disclaimer string false none none
»»»»»»»»» publishRule integer(int32) false none none
»»»»»»» contentVersions object false none none
»»»»»»» languageCount integer(int32) false none none
»»»»»» printSequence integer(int32) false none none
»»»»»» sortLock string false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» entityID integer(int32) false none none
»»»»»» contentID integer(int32) false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» pageLayoutID integer(int32) false none none
»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»» elementForFilename integer(int32) false none none
»»»»»»» alias string false none none
»»»»»»» directEditEnabled boolean false none none
»»»»»»»»» sequence integer(int32) false none none
»»»»»»»» restricted boolean false none none
»»»»»»» duplicate boolean false none none
»»»»»»» type integer(int32) false none none
»»»»»»» sectionID integer(int32) false none none
»»»»»»» minAuthLevel integer(int32) false none none
»»»»»» scope integer(int32) false none none
»»»»»» contentTypeID integer(int32) false none none
»»»»» sortLock string false none none
»»»» language string false none none
»»»» name string false none none
»»»» owner integer(int32) false none none
»»»» id integer(int32) false none none
»»» fullLocaleCode string false none none
» users [object] false none none
»» additionalProperties string false none none
» notificationProperties object false none none
» notificationScheduled boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

packages

These endpoints provide the functionality for interacting with Packages in the TERMINALFOUR system.

list

GET /packages

Example responses

200 Response

[
  {
    "name": "string",
    "description": "string",
    "createdDate": "string",
    "status": true,
    "error": true,
    "type": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<name>string</name>
<description>string</description>
<createdDate>string</createdDate>
<status>true</status>
<error>true</error>
<type>string</type>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

allowedPackageList

GET /packages/allowed

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

archiveUpload

POST /packages/archiveUpload

Example responses

200 Response

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<Manifest>
  <referencedAssets>
    <graph>
      <vertices/>
      <edges/>
    </graph>
  </referencedAssets>
  <languages>string</languages>
  <name>string</name>
  <report>
    <reportType>IMPORT</reportType>
    <entries/>
    <error>true</error>
    <importReportDirectory>string</importReportDirectory>
    <packageName>string</packageName>
    <errorReportEntry>
      <asset/>
      <action/>
      <status/>
      <date/>
      <error/>
      <packageName/>
    </errorReportEntry>
  </report>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <error>true</error>
  <errorMessage>
    <asset>
      <id/>
      <assetType/>
      <fromSection/>
      <languageCode/>
      <fromContentId/>
      <names/>
      <systemAsset/>
      <fileLocation/>
      <error/>
      <fromContentTypeIds/>
      <assetProperties/>
    </asset>
    <action>RESOLVE</action>
    <status>SUCCESS</status>
    <date>string</date>
    <error>string</error>
    <packageName>string</packageName>
  </errorMessage>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
  <importMap>
    <property1>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property1>
    <property2>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property2>
  </importMap>
  <orderedAssets>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </orderedAssets>
</Manifest>

Responses

Status Meaning Description Schema
200 OK successful operation Manifest

create

POST /packages/create/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<Manifest>
  <referencedAssets>
    <graph>
      <vertices/>
      <edges/>
    </graph>
  </referencedAssets>
  <languages>string</languages>
  <name>string</name>
  <report>
    <reportType>IMPORT</reportType>
    <entries/>
    <error>true</error>
    <importReportDirectory>string</importReportDirectory>
    <packageName>string</packageName>
    <errorReportEntry>
      <asset/>
      <action/>
      <status/>
      <date/>
      <error/>
      <packageName/>
    </errorReportEntry>
  </report>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <error>true</error>
  <errorMessage>
    <asset>
      <id/>
      <assetType/>
      <fromSection/>
      <languageCode/>
      <fromContentId/>
      <names/>
      <systemAsset/>
      <fileLocation/>
      <error/>
      <fromContentTypeIds/>
      <assetProperties/>
    </asset>
    <action>RESOLVE</action>
    <status>SUCCESS</status>
    <date>string</date>
    <error>string</error>
    <packageName>string</packageName>
  </errorMessage>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
  <importMap>
    <property1>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property1>
    <property2>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property2>
  </importMap>
  <orderedAssets>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </orderedAssets>
</Manifest>

Responses

Status Meaning Description Schema
200 OK successful operation Manifest

download

GET /packages/download/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "filename": "string",
  "file": "string",
  "mimeType": "string",
  "fileLocation": "string",
  "code": "string",
  "cleanUp": true,
  "contentID": 0,
  "language": "string",
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "element": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<fileDownload>
  <filename>string</filename>
  <file>string</file>
  <mimeType>string</mimeType>
  <fileLocation>string</fileLocation>
  <code>string</code>
  <cleanUp>true</cleanUp>
  <contentID>0</contentID>
  <language>string</language>
  <version>
    <version>string</version>
    <subMinor>0</subMinor>
    <major>0</major>
    <minor>0</minor>
  </version>
  <element>string</element>
</fileDownload>

Responses

Status Meaning Description Schema
200 OK successful operation FileDownload

downloadUrl

POST /packages/downloadUrl

Responses

Status Meaning Description Schema
default Default successful operation None

editView

GET /packages/edit/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "languages": [
    "string"
  ],
  "name": "string",
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ManifestDTO>
  <languages>string</languages>
  <name>string</name>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
</ManifestDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ManifestDTO

export

POST /packages/export/{name}

Example responses

200 Response

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<Manifest>
  <referencedAssets>
    <graph>
      <vertices/>
      <edges/>
    </graph>
  </referencedAssets>
  <languages>string</languages>
  <name>string</name>
  <report>
    <reportType>IMPORT</reportType>
    <entries/>
    <error>true</error>
    <importReportDirectory>string</importReportDirectory>
    <packageName>string</packageName>
    <errorReportEntry>
      <asset/>
      <action/>
      <status/>
      <date/>
      <error/>
      <packageName/>
    </errorReportEntry>
  </report>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <error>true</error>
  <errorMessage>
    <asset>
      <id/>
      <assetType/>
      <fromSection/>
      <languageCode/>
      <fromContentId/>
      <names/>
      <systemAsset/>
      <fileLocation/>
      <error/>
      <fromContentTypeIds/>
      <assetProperties/>
    </asset>
    <action>RESOLVE</action>
    <status>SUCCESS</status>
    <date>string</date>
    <error>string</error>
    <packageName>string</packageName>
  </errorMessage>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
  <importMap>
    <property1>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property1>
    <property2>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property2>
  </importMap>
  <orderedAssets>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </orderedAssets>
</Manifest>

Responses

Status Meaning Description Schema
200 OK successful operation Manifest

uploadHtmlArchive

POST /packages/html

Example responses

200 Response

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<Manifest>
  <referencedAssets>
    <graph>
      <vertices/>
      <edges/>
    </graph>
  </referencedAssets>
  <languages>string</languages>
  <name>string</name>
  <report>
    <reportType>IMPORT</reportType>
    <entries/>
    <error>true</error>
    <importReportDirectory>string</importReportDirectory>
    <packageName>string</packageName>
    <errorReportEntry>
      <asset/>
      <action/>
      <status/>
      <date/>
      <error/>
      <packageName/>
    </errorReportEntry>
  </report>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <error>true</error>
  <errorMessage>
    <asset>
      <id/>
      <assetType/>
      <fromSection/>
      <languageCode/>
      <fromContentId/>
      <names/>
      <systemAsset/>
      <fileLocation/>
      <error/>
      <fromContentTypeIds/>
      <assetProperties/>
    </asset>
    <action>RESOLVE</action>
    <status>SUCCESS</status>
    <date>string</date>
    <error>string</error>
    <packageName>string</packageName>
  </errorMessage>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
  <importMap>
    <property1>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property1>
    <property2>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property2>
  </importMap>
  <orderedAssets>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </orderedAssets>
</Manifest>

Responses

Status Meaning Description Schema
200 OK successful operation Manifest

importInfo

GET /packages/import/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "name": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ImportDTO>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <name>string</name>
</ImportDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ImportDTO

importAssets

PUT /packages/import/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<Manifest>
  <referencedAssets>
    <graph>
      <vertices/>
      <edges/>
    </graph>
  </referencedAssets>
  <languages>string</languages>
  <name>string</name>
  <report>
    <reportType>IMPORT</reportType>
    <entries/>
    <error>true</error>
    <importReportDirectory>string</importReportDirectory>
    <packageName>string</packageName>
    <errorReportEntry>
      <asset/>
      <action/>
      <status/>
      <date/>
      <error/>
      <packageName/>
    </errorReportEntry>
  </report>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <error>true</error>
  <errorMessage>
    <asset>
      <id/>
      <assetType/>
      <fromSection/>
      <languageCode/>
      <fromContentId/>
      <names/>
      <systemAsset/>
      <fileLocation/>
      <error/>
      <fromContentTypeIds/>
      <assetProperties/>
    </asset>
    <action>RESOLVE</action>
    <status>SUCCESS</status>
    <date>string</date>
    <error>string</error>
    <packageName>string</packageName>
  </errorMessage>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
  <importMap>
    <property1>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property1>
    <property2>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property2>
  </importMap>
  <orderedAssets>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </orderedAssets>
</Manifest>

Responses

Status Meaning Description Schema
200 OK successful operation Manifest

noXhrArchiveUpload

POST /packages/noxhr/archiveUpload

Responses

Status Meaning Description Schema
default Default successful operation None

loadPackage

POST /packages/noxhr/load

Responses

Status Meaning Description Schema
default Default successful operation None

previewMapping

POST /packages/preview

Example responses

200 Response

{
  "url": "string",
  "mappingType": "XPATH",
  "mappingValue": "string",
  "defaultValue": "string",
  "dateFormat": "string",
  "content": 0,
  "id": 0,
  "parameters": {
    "property1": true,
    "property2": true
  },
  "html": "string",
  "list": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<MappingPreviewDTO>
  <url>string</url>
  <mappingType>XPATH</mappingType>
  <mappingValue>string</mappingValue>
  <defaultValue>string</defaultValue>
  <dateFormat>string</dateFormat>
  <content>0</content>
  <id>0</id>
  <parameters>
    <property1>true</property1>
    <property2>true</property2>
  </parameters>
  <html>string</html>
  <list>true</list>
</MappingPreviewDTO>

Responses

Status Meaning Description Schema
200 OK successful operation MappingPreviewDTO

POST /packages/resolveSectionLinks

Status Meaning Description Schema
default Default successful operation None

resumeImport

GET /packages/resumeImport/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<Manifest>
  <referencedAssets>
    <graph>
      <vertices/>
      <edges/>
    </graph>
  </referencedAssets>
  <languages>string</languages>
  <name>string</name>
  <report>
    <reportType>IMPORT</reportType>
    <entries/>
    <error>true</error>
    <importReportDirectory>string</importReportDirectory>
    <packageName>string</packageName>
    <errorReportEntry>
      <asset/>
      <action/>
      <status/>
      <date/>
      <error/>
      <packageName/>
    </errorReportEntry>
  </report>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <error>true</error>
  <errorMessage>
    <asset>
      <id/>
      <assetType/>
      <fromSection/>
      <languageCode/>
      <fromContentId/>
      <names/>
      <systemAsset/>
      <fileLocation/>
      <error/>
      <fromContentTypeIds/>
      <assetProperties/>
    </asset>
    <action>RESOLVE</action>
    <status>SUCCESS</status>
    <date>string</date>
    <error>string</error>
    <packageName>string</packageName>
  </errorMessage>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
  <importMap>
    <property1>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property1>
    <property2>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property2>
  </importMap>
  <orderedAssets>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </orderedAssets>
</Manifest>

Responses

Status Meaning Description Schema
200 OK successful operation Manifest

rollBack

GET /packages/rollback/{name}

Parameters

Name In Type Required Description
name path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

runningActions

GET /packages/status

Example responses

200 Response

[
  {
    "key": "string",
    "moduleName": "string",
    "progress": 0,
    "totalOperations": 0,
    "taskName": "string",
    "cancelled": true,
    "percentage": 0,
    "task": "RESOLVE",
    "summary": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<key>string</key>
<moduleName>string</moduleName>
<progress>0</progress>
<totalOperations>0</totalOperations>
<taskName>string</taskName>
<cancelled>true</cancelled>
<percentage>0</percentage>
<task>RESOLVE</task>
<summary>string</summary>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

cancelOperation

GET /packages/status/cancel/{key}

Parameters

Name In Type Required Description
key path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

status

GET /packages/status/update/{key}

Parameters

Name In Type Required Description
key path string true none

Example responses

200 Response

{
  "key": "string",
  "moduleName": "string",
  "progress": 0,
  "totalOperations": 0,
  "taskName": "string",
  "cancelled": true,
  "percentage": 0,
  "task": "RESOLVE",
  "summary": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<IStatus>
  <key>string</key>
  <moduleName>string</moduleName>
  <progress>0</progress>
  <totalOperations>0</totalOperations>
  <taskName>string</taskName>
  <cancelled>true</cancelled>
  <percentage>0</percentage>
  <task>RESOLVE</task>
  <summary>string</summary>
</IStatus>

Responses

Status Meaning Description Schema
200 OK successful operation IStatus

upload

POST /packages/upload

Responses

Status Meaning Description Schema
default Default successful operation None

detailedView

GET /packages/{name}

Parameters

Name In Type Required Description
name path string true none

Example responses

200 Response

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<Manifest>
  <referencedAssets>
    <graph>
      <vertices/>
      <edges/>
    </graph>
  </referencedAssets>
  <languages>string</languages>
  <name>string</name>
  <report>
    <reportType>IMPORT</reportType>
    <entries/>
    <error>true</error>
    <importReportDirectory>string</importReportDirectory>
    <packageName>string</packageName>
    <errorReportEntry>
      <asset/>
      <action/>
      <status/>
      <date/>
      <error/>
      <packageName/>
    </errorReportEntry>
  </report>
  <configuration>
    <property1/>
    <property2/>
  </configuration>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <error>true</error>
  <errorMessage>
    <asset>
      <id/>
      <assetType/>
      <fromSection/>
      <languageCode/>
      <fromContentId/>
      <names/>
      <systemAsset/>
      <fileLocation/>
      <error/>
      <fromContentTypeIds/>
      <assetProperties/>
    </asset>
    <action>RESOLVE</action>
    <status>SUCCESS</status>
    <date>string</date>
    <error>string</error>
    <packageName>string</packageName>
  </errorMessage>
  <description>string</description>
  <importGroup>0</importGroup>
  <primaryLanguage>string</primaryLanguage>
  <seeds>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </seeds>
  <channelID>0</channelID>
  <importMap>
    <property1>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property1>
    <property2>
      <id>0</id>
      <assetType>[</assetType>
      <fromSection>0</fromSection>
      <languageCode>string</languageCode>
      <fromContentId>0</fromContentId>
      <names/>
      <systemAsset>true</systemAsset>
      <fileLocation>string</fileLocation>
      <error>true</error>
      <fromContentTypeIds/>
      <assetProperties/>
    </property2>
  </importMap>
  <orderedAssets>
    <id>0</id>
    <assetType>[</assetType>
    <fromSection>0</fromSection>
    <languageCode>string</languageCode>
    <fromContentId>0</fromContentId>
    <names/>
    <systemAsset>true</systemAsset>
    <fileLocation>string</fileLocation>
    <error>true</error>
    <fromContentTypeIds/>
    <assetProperties/>
  </orderedAssets>
</Manifest>

Responses

Status Meaning Description Schema
200 OK successful operation Manifest

delete

DELETE /packages/{name}

Parameters

Name In Type Required Description
name path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

pageLayout

These endpoints provide the functionality for interacting with page layouts in the TERMINALFOUR system.

list

GET /pageLayout

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    },
    "sharedGroupCount": 0,
    "sharedGroups": [
      {
        "ownershipLevel": null,
        "group": null,
        "assetID": null,
        "groupID": null,
        "assetType": null,
        "readLevel": null,
        "groupName": null
      }
    ],
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-08-24T14:15:22Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true,
      "language": "string"
    },
    "fullyAccessible": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<editable>true</editable>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group/>
  <assetID>0</assetID>
  <groupID>0</groupID>
  <assetType>0</assetType>
  <readLevel>0</readLevel>
  <groupName>string</groupName>
</primaryGroup>
<sharedGroupCount>0</sharedGroupCount>
<sharedGroups>
  <ownershipLevel/>
  <group/>
  <assetID/>
  <groupID/>
  <assetType/>
  <readLevel/>
  <groupName/>
</sharedGroups>
<lock>
  <assetID>0</assetID>
  <assetType>0</assetType>
  <lockType>0</lockType>
  <expiry>2019-08-24T14:15:22Z</expiry>
  <owner>0</owner>
  <ownerName>string</ownerName>
  <currentUser>true</currentUser>
  <language>string</language>
</lock>
<fullyAccessible>true</fullyAccessible>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PageLayoutMetaDataDTO] false none none
» sharedGroupCount integer(int32) false none none
» sharedGroups [AssetSharingInformation] false none none

add

POST /pageLayout

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroupCount": 0,
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "syntaxType": 0,
  "status": 0,
  "headerCode": "string",
  "footerCode": "string",
  "stylesheetCode": "string",
  "fileExtension": "string",
  "contentLayout": "string",
  "currentVersion": "string",
  "language": "string",
  "layoutProcessor": 0,
  "typeContent": "string",
  "showOwner": true,
  "fullyAccessible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<PageLayoutDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroupCount>0</sharedGroupCount>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <syntaxType>0</syntaxType>
  <status>0</status>
  <headerCode>string</headerCode>
  <footerCode>string</footerCode>
  <stylesheetCode>string</stylesheetCode>
  <fileExtension>string</fileExtension>
  <contentLayout>string</contentLayout>
  <currentVersion>string</currentVersion>
  <language>string</language>
  <layoutProcessor>0</layoutProcessor>
  <typeContent>string</typeContent>
  <showOwner>true</showOwner>
  <fullyAccessible>true</fullyAccessible>
</PageLayoutDTO>

Responses

Status Meaning Description Schema
200 OK successful operation PageLayoutDTO

grouped

GET /pageLayout/grouped

Example responses

200 Response

[
  {
    "groupName": "string",
    "pageLayoutMetaData": [
      {
        "id": null,
        "name": null,
        "description": null,
        "editable": null,
        "primaryGroup": null,
        "sharedGroupCount": null,
        "sharedGroups": null,
        "lock": null,
        "fullyAccessible": null
      }
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<groupName>string</groupName>
<pageLayoutMetaData>
  <id/>
  <name/>
  <description/>
  <editable/>
  <primaryGroup/>
  <sharedGroupCount/>
  <sharedGroups/>
  <lock/>
  <fullyAccessible/>
</pageLayoutMetaData>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PageLayoutGroupDTO] false none none
»» sharedGroupCount integer(int32) false none none
»» sharedGroups [AssetSharingInformation] false none none

get

GET /pageLayout/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroupCount": 0,
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "syntaxType": 0,
  "status": 0,
  "headerCode": "string",
  "footerCode": "string",
  "stylesheetCode": "string",
  "fileExtension": "string",
  "contentLayout": "string",
  "currentVersion": "string",
  "language": "string",
  "layoutProcessor": 0,
  "typeContent": "string",
  "showOwner": true,
  "fullyAccessible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<PageLayoutDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroupCount>0</sharedGroupCount>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <syntaxType>0</syntaxType>
  <status>0</status>
  <headerCode>string</headerCode>
  <footerCode>string</footerCode>
  <stylesheetCode>string</stylesheetCode>
  <fileExtension>string</fileExtension>
  <contentLayout>string</contentLayout>
  <currentVersion>string</currentVersion>
  <language>string</language>
  <layoutProcessor>0</layoutProcessor>
  <typeContent>string</typeContent>
  <showOwner>true</showOwner>
  <fullyAccessible>true</fullyAccessible>
</PageLayoutDTO>

Responses

Status Meaning Description Schema
200 OK successful operation PageLayoutDTO

modify

PUT /pageLayout/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroupCount": 0,
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "syntaxType": 0,
  "status": 0,
  "headerCode": "string",
  "footerCode": "string",
  "stylesheetCode": "string",
  "fileExtension": "string",
  "contentLayout": "string",
  "currentVersion": "string",
  "language": "string",
  "layoutProcessor": 0,
  "typeContent": "string",
  "showOwner": true,
  "fullyAccessible": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<PageLayoutDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <editable>true</editable>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroupCount>0</sharedGroupCount>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-08-24T14:15:22Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
    <language>string</language>
  </lock>
  <syntaxType>0</syntaxType>
  <status>0</status>
  <headerCode>string</headerCode>
  <footerCode>string</footerCode>
  <stylesheetCode>string</stylesheetCode>
  <fileExtension>string</fileExtension>
  <contentLayout>string</contentLayout>
  <currentVersion>string</currentVersion>
  <language>string</language>
  <layoutProcessor>0</layoutProcessor>
  <typeContent>string</typeContent>
  <showOwner>true</showOwner>
  <fullyAccessible>true</fullyAccessible>
</PageLayoutDTO>

Responses

Status Meaning Description Schema
200 OK successful operation PageLayoutDTO

delete

DELETE /pageLayout/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getSharingInformation

GET /pageLayout/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

modifySharingInformation

PUT /pageLayout/{id}/share

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<IGroupedAssetSharingInformation>
  <id>0</id>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id/>
      <name/>
      <description/>
      <emailAddress/>
      <createDate/>
      <enabled/>
      <ldap/>
      <defaultChannel/>
      <deleted/>
    </group>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group/>
    <assetID>0</assetID>
    <groupID>0</groupID>
    <assetType>0</assetType>
    <readLevel>0</readLevel>
    <groupName>string</groupName>
  </sharedGroups>
</IGroupedAssetSharingInformation>

Responses

Status Meaning Description Schema
200 OK successful operation IGroupedAssetSharingInformation

pagelayoutReport

These endpoints describe the functionality for generating a Page Layout report.

createPageLayoutReport

POST /pagelayoutReport

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

downloadReport

GET /pagelayoutReport/download/{id}

Parameters

Name In Type Required Description
id path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /pagelayoutReport/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPage>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPage>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPage

password

This web service allows a user to reset their password.

performReset

POST /password/reset

Body parameter

{
  "username": "string",
  "nonce": "string"
}

Parameters

Name In Type Required Description
body body ResetRequest false none

Responses

Status Meaning Description Schema
default Default successful operation None

startReset

POST /password/startreset

Body parameter

{
  "username": "string",
  "nonce": "string"
}

Parameters

Name In Type Required Description
body body ResetRequest false none

Responses

Status Meaning Description Schema
default Default successful operation None

paymentgateway

These endpoints describe interacting with the Formbuilder payment gateway system.

listPaymentGateways

GET /paymentgateway

Example responses

200 Response

[
  {
    "gatewayName": "string",
    "requiredChargeConfigurationOptions": [
      "string"
    ],
    "requiredSetupConfigurationOptions": [
      "string"
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<gatewayName>string</gatewayName>
<requiredChargeConfigurationOptions>string</requiredChargeConfigurationOptions>
<requiredSetupConfigurationOptions>string</requiredSetupConfigurationOptions>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

listPaymentGatewayProfiles

GET /paymentgateway/profile

Example responses

200 Response

[
  {
    "id": 0,
    "customerId": 0,
    "name": "string",
    "description": "string",
    "type": "string",
    "lastModified": "2019-08-24T14:15:22Z",
    "properties": {
      "property1": "string",
      "property2": "string"
    }
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<customerId>0</customerId>
<name>string</name>
<description>string</description>
<type>string</type>
<lastModified>2019-08-24T14:15:22Z</lastModified>
<properties>
  <property1>string</property1>
  <property2>string</property2>
</properties>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

addPaymentGatewayProfile

POST /paymentgateway/profile

Example responses

200 Response

{
  "id": 0,
  "customerId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": "string",
    "property2": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<PaymentGatewayProfile>
  <id>0</id>
  <customerId>0</customerId>
  <name>string</name>
  <description>string</description>
  <type>string</type>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <properties>
    <property1>string</property1>
    <property2>string</property2>
  </properties>
</PaymentGatewayProfile>

Responses

Status Meaning Description Schema
200 OK successful operation PaymentGatewayProfile

getGatewayProfile

GET /paymentgateway/profile/{gatewayProfileId}

Parameters

Name In Type Required Description
gatewayProfileId path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "customerId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": "string",
    "property2": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<PaymentGatewayProfile>
  <id>0</id>
  <customerId>0</customerId>
  <name>string</name>
  <description>string</description>
  <type>string</type>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <properties>
    <property1>string</property1>
    <property2>string</property2>
  </properties>
</PaymentGatewayProfile>

Responses

Status Meaning Description Schema
200 OK successful operation PaymentGatewayProfile

deletePaymentGatewayProfile

DELETE /paymentgateway/profile/{gatewayProfileId}

Parameters

Name In Type Required Description
gatewayProfileId path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

modifyPaymentGatewayProfile

PUT /paymentgateway/profile/{profileId}

Parameters

Name In Type Required Description
profileId path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "customerId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": "string",
    "property2": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<PaymentGatewayProfile>
  <id>0</id>
  <customerId>0</customerId>
  <name>string</name>
  <description>string</description>
  <type>string</type>
  <lastModified>2019-08-24T14:15:22Z</lastModified>
  <properties>
    <property1>string</property1>
    <property2>string</property2>
  </properties>
</PaymentGatewayProfile>

Responses

Status Meaning Description Schema
200 OK successful operation PaymentGatewayProfile

plsetting

These endpoints provide the functionality for listing the persistent language settings in the TERMINALFOUR system.

list

GET /plsetting

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

preview

These endpoints describe interacting with the preview functionality.

previewPage

GET /preview/{id}/{language}/{section}

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
section path integer(int32) true none
cc query integer(int32) false none

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK successful operation string

previewFulltextPage

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

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
section path integer(int32) true none
content path integer(int32) true none
layout path string true none
cc query integer(int32) false none

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK successful operation string

previewfilter

These end points describe operations on Preview filters within the TERMINALFOUR system.

list

GET /previewfilter

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "enabled": true,
    "method": 0,
    "url": "string",
    "dir": "string",
    "extension": "string",
    "passThru": "string",
    "params": [
      "string"
    ]
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<method>0</method>
<url>string</url>
<dir>string</dir>
<extension>string</extension>
<passThru>string</passThru>
<params>string</params>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /previewfilter

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "enabled": true,
  "method": 0,
  "url": "string",
  "dir": "string",
  "extension": "string",
  "passThru": "string",
  "params": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<PreviewFilterDTO>
  <id>0</id>
  <name>string</name>
  <enabled>true</enabled>
  <method>0</method>
  <url>string</url>
  <dir>string</dir>
  <extension>string</extension>
  <passThru>string</passThru>
  <params>string</params>
</PreviewFilterDTO>

Responses

Status Meaning Description Schema
200 OK successful operation PreviewFilterDTO

get

GET /previewfilter/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "enabled": true,
  "method": 0,
  "url": "string",
  "dir": "string",
  "extension": "string",
  "passThru": "string",
  "params": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<PreviewFilterDTO>
  <id>0</id>
  <name>string</name>
  <enabled>true</enabled>
  <method>0</method>
  <url>string</url>
  <dir>string</dir>
  <extension>string</extension>
  <passThru>string</passThru>
  <params>string</params>
</PreviewFilterDTO>

Responses

Status Meaning Description Schema
200 OK successful operation PreviewFilterDTO

update

PUT /previewfilter/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /previewfilter/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

profile

This service is used to interact with the profile of a current user.

getProfile

GET /profile

Example responses

200 Response

{
  "firstName": "string",
  "lastName": "string",
  "username": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "oldPassword": "string",
  "newPassword": "string",
  "newPasswordConfirm": "string",
  "uiLocale": "string",
  "htmlEditorId": 0,
  "defaultPreviewChannelId": 0,
  "userLevel": 0,
  "contentId": 0,
  "contentDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserProfileView>
  <firstName>string</firstName>
  <lastName>string</lastName>
  <username>string</username>
  <emailAddress>string</emailAddress>
  <defaultLanguage>string</defaultLanguage>
  <oldPassword>string</oldPassword>
  <newPassword>string</newPassword>
  <newPasswordConfirm>string</newPasswordConfirm>
  <uiLocale>string</uiLocale>
  <htmlEditorId>0</htmlEditorId>
  <defaultPreviewChannelId>0</defaultPreviewChannelId>
  <userLevel>0</userLevel>
  <contentId>0</contentId>
  <contentDto>
    <id>0</id>
    <contentTypeID>0</contentTypeID>
    <archiveSection>0</archiveSection>
    <publishDate>2019-08-24T14:15:22Z</publishDate>
    <reviewDate>2019-08-24T14:15:22Z</reviewDate>
    <expiryDate>2019-08-24T14:15:22Z</expiryDate>
    <language>string</language>
    <name>string</name>
    <alternativeLanguages/>
    <status>0</status>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <lastModifiedBy>0</lastModifiedBy>
    <lastModifierName>string</lastModifierName>
    <contentTypeName>string</contentTypeName>
    <contentTypeAlias>string</contentTypeAlias>
    <owner>
      <id/>
      <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/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </lock>
    <canPublishNow>true</canPublishNow>
    <canSaveAndApprove>true</canSaveAndApprove>
    <contentTypeAccess>0</contentTypeAccess>
    <contentTypeLock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </contentTypeLock>
    <elements>
      <property1/>
      <property2/>
    </elements>
    <contentType>
      <id/>
      <name/>
      <description/>
      <type/>
      <editable/>
      <primaryGroup/>
      <sharedGroups/>
      <alias/>
      <workflow/>
      <systemTemplate/>
      <sharedGroupCount/>
      <contentTypeElements/>
      <metaMapped/>
      <lock/>
      <minAuthLevel/>
      <enableDirectEdit/>
      <elementIdforFilename/>
      <warningMessage/>
      <sectionId/>
      <duplicate/>
      <duplicatedFromId/>
      <fullyAccessible/>
    </contentType>
    <types/>
    <insertAtIndex>0</insertAtIndex>
    <sortLock>TOP</sortLock>
    <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
    <locked>true</locked>
    <sectionIDs>0</sectionIDs>
  </contentDto>
</UserProfileView>

Responses

Status Meaning Description Schema
200 OK successful operation UserProfileView

updateProfile

POST /profile

Example responses

200 Response

{
  "firstName": "string",
  "lastName": "string",
  "username": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "oldPassword": "string",
  "newPassword": "string",
  "newPasswordConfirm": "string",
  "uiLocale": "string",
  "htmlEditorId": 0,
  "defaultPreviewChannelId": 0,
  "userLevel": 0,
  "contentId": 0,
  "contentDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserProfileView>
  <firstName>string</firstName>
  <lastName>string</lastName>
  <username>string</username>
  <emailAddress>string</emailAddress>
  <defaultLanguage>string</defaultLanguage>
  <oldPassword>string</oldPassword>
  <newPassword>string</newPassword>
  <newPasswordConfirm>string</newPasswordConfirm>
  <uiLocale>string</uiLocale>
  <htmlEditorId>0</htmlEditorId>
  <defaultPreviewChannelId>0</defaultPreviewChannelId>
  <userLevel>0</userLevel>
  <contentId>0</contentId>
  <contentDto>
    <id>0</id>
    <contentTypeID>0</contentTypeID>
    <archiveSection>0</archiveSection>
    <publishDate>2019-08-24T14:15:22Z</publishDate>
    <reviewDate>2019-08-24T14:15:22Z</reviewDate>
    <expiryDate>2019-08-24T14:15:22Z</expiryDate>
    <language>string</language>
    <name>string</name>
    <alternativeLanguages/>
    <status>0</status>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <lastModifiedBy>0</lastModifiedBy>
    <lastModifierName>string</lastModifierName>
    <contentTypeName>string</contentTypeName>
    <contentTypeAlias>string</contentTypeAlias>
    <owner>
      <id/>
      <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/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </lock>
    <canPublishNow>true</canPublishNow>
    <canSaveAndApprove>true</canSaveAndApprove>
    <contentTypeAccess>0</contentTypeAccess>
    <contentTypeLock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </contentTypeLock>
    <elements>
      <property1/>
      <property2/>
    </elements>
    <contentType>
      <id/>
      <name/>
      <description/>
      <type/>
      <editable/>
      <primaryGroup/>
      <sharedGroups/>
      <alias/>
      <workflow/>
      <systemTemplate/>
      <sharedGroupCount/>
      <contentTypeElements/>
      <metaMapped/>
      <lock/>
      <minAuthLevel/>
      <enableDirectEdit/>
      <elementIdforFilename/>
      <warningMessage/>
      <sectionId/>
      <duplicate/>
      <duplicatedFromId/>
      <fullyAccessible/>
    </contentType>
    <types/>
    <insertAtIndex>0</insertAtIndex>
    <sortLock>TOP</sortLock>
    <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
    <locked>true</locked>
    <sectionIDs>0</sectionIDs>
  </contentDto>
</UserProfileView>

Responses

Status Meaning Description Schema
200 OK successful operation UserProfileView

profilebookmark

Provides web service endpoints for the TERMINALFOUR bookmarks functionality.

list

GET /profile/bookmark

Example responses

200 Response

[
  {
    "id": 0,
    "description": "string",
    "url": "string",
    "icon": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<description>string</description>
<url>string</url>
<icon>string</icon>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

create

POST /profile/bookmark

Example responses

200 Response

{
  "id": 0,
  "description": "string",
  "url": "string",
  "icon": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<BookmarkDTO>
  <id>0</id>
  <description>string</description>
  <url>string</url>
  <icon>string</icon>
</BookmarkDTO>

Responses

Status Meaning Description Schema
200 OK successful operation BookmarkDTO

delete

DELETE /profile/bookmark/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

publishlogs

These endpoints provide the functionality to output the publish logs to the publish page.

tailLogForPublish

POST /publishlogs

Example responses

200 Response

{
  "lines": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<PublishOutput>
  <lines>string</lines>
</PublishOutput>

Responses

Status Meaning Description Schema
200 OK successful operation PublishOutput

publishProcessor

These endpoints provide the functionality for listing the Publish processors in the TERMINALFOUR system.

list

GET /publishProcessor/{type}

Parameters

Name In Type Required Description
type path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "processableType": 0,
    "description": "string",
    "enabled": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<processableType>0</processableType>
<description>string</description>
<enabled>true</enabled>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

pxlconfig

getPxlConfig

GET /pxlconfig

Example responses

200 Response

{
  "privateIpMatching": true,
  "clientOrgId": "string",
  "pxlEnabled": true,
  "environmentIdentifier": "string",
  "valid": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlConfig>
  <privateIpMatching>true</privateIpMatching>
  <clientOrgId>string</clientOrgId>
  <pxlEnabled>true</pxlEnabled>
  <environmentIdentifier>string</environmentIdentifier>
  <valid>true</valid>
</pxlConfig>

Responses

Status Meaning Description Schema
200 OK successful operation PxlConfigurationDTO

saveAndConnect

POST /pxlconfig

Example responses

200 Response

{
  "privateIpMatching": true,
  "clientOrgId": "string",
  "pxlEnabled": true,
  "environmentIdentifier": "string",
  "valid": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlConfig>
  <privateIpMatching>true</privateIpMatching>
  <clientOrgId>string</clientOrgId>
  <pxlEnabled>true</pxlEnabled>
  <environmentIdentifier>string</environmentIdentifier>
  <valid>true</valid>
</pxlConfig>

Responses

Status Meaning Description Schema
200 OK successful operation PxlConfigurationDTO

updateAndConnect

PUT /pxlconfig

Example responses

200 Response

{
  "privateIpMatching": true,
  "clientOrgId": "string",
  "pxlEnabled": true,
  "environmentIdentifier": "string",
  "valid": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlConfig>
  <privateIpMatching>true</privateIpMatching>
  <clientOrgId>string</clientOrgId>
  <pxlEnabled>true</pxlEnabled>
  <environmentIdentifier>string</environmentIdentifier>
  <valid>true</valid>
</pxlConfig>

Responses

Status Meaning Description Schema
200 OK successful operation PxlConfigurationDTO

isPxlEnabled

GET /pxlconfig/enabled

Example responses

200 Response

{
  "globalPxlSet": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlGlobalConfig>
  <globalPxlSet>true</globalPxlSet>
</pxlGlobalConfig>

Responses

Status Meaning Description Schema
200 OK successful operation PxlGlobalConfigDTO

validatePxlConfig

POST /pxlconfig/validate

Example responses

200 Response

{
  "privateIpMatching": true,
  "clientOrgId": "string",
  "pxlEnabled": true,
  "environmentIdentifier": "string",
  "valid": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlConfig>
  <privateIpMatching>true</privateIpMatching>
  <clientOrgId>string</clientOrgId>
  <pxlEnabled>true</pxlEnabled>
  <environmentIdentifier>string</environmentIdentifier>
  <valid>true</valid>
</pxlConfig>

Responses

Status Meaning Description Schema
200 OK successful operation PxlConfigurationDTO

pxlfilter

list

POST /pxlfilter/list

Example responses

200 Response

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "pxlFilters": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "url": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ],
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "url": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<PxlFilterTableData>
  <draw>0</draw>
  <recordsTotal>0</recordsTotal>
  <recordsFiltered>0</recordsFiltered>
  <pxlFilters>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <url>string</url>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
  </pxlFilters>
  <data>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <url>string</url>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
  </data>
</PxlFilterTableData>

Responses

Status Meaning Description Schema
200 OK successful operation PxlFilterTableData

add

POST /pxlfilter

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "filterUrl": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlfilter>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <filterUrl>string</filterUrl>
</pxlfilter>

Responses

Status Meaning Description Schema
200 OK successful operation PxlFilterDTO

validatePxlFilterName

POST /pxlfilter/inputvalidation/pxlfiltername

Example responses

200 Response

{
  "value": "string",
  "inputIsValid": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<PxlFilterUniqueNameDTO>
  <value>string</value>
  <inputIsValid>true</inputIsValid>
</PxlFilterUniqueNameDTO>

Responses

Status Meaning Description Schema
200 OK successful operation PxlFilterUniqueNameDTO

simpleList

GET /pxlfilter/simplelist

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /pxlfilter/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "filterUrl": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlfilter>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <filterUrl>string</filterUrl>
</pxlfilter>

Responses

Status Meaning Description Schema
200 OK successful operation PxlFilterDTO

modify

PUT /pxlfilter/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "filterUrl": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlfilter>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <filterUrl>string</filterUrl>
</pxlfilter>

Responses

Status Meaning Description Schema
200 OK successful operation PxlFilterDTO

delete

DELETE /pxlfilter/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "filterUrl": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<pxlfilter>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <filterUrl>string</filterUrl>
</pxlfilter>

Responses

Status Meaning Description Schema
200 OK successful operation PxlFilterDTO

reportaudittrail

These endpoints provide the functionality to create an audit trail report.

create

POST /report/audittrail

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

downloadReport

GET /report/audittrail/download/{id}

Parameters

Name In Type Required Description
id path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /report/audittrail/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPageRow>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPageRow>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPageRow

reportbrokenlinks

Provides different operations relating to the management of Broken Links reports.

createReport

POST /report/brokenlinks

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

get

GET /report/brokenlinks/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {
      "content": {},
      "language": "string",
      "sections": [
        null
      ],
      "type": "[",
      "responseCode": 0,
      "errorMessage": "string",
      "url": "string",
      "contentTypeID": 0,
      "contentTypeElementIDs": [
        null
      ]
    }
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPageBrokenLinksRow>
  <rows>
    <content/>
    <language>string</language>
    <sections/>
    <type>[</type>
    <responseCode>0</responseCode>
    <errorMessage>string</errorMessage>
    <url>string</url>
    <contentTypeID>0</contentTypeID>
    <contentTypeElementIDs/>
  </rows>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPageBrokenLinksRow>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPageBrokenLinksRow

reportcontentowner

These endpoints describe operations on Content Owner reports within the TERMINALFOUR system.

createReport

POST /report/contentowner

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

get

GET /report/contentowner/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {
      "content": {},
      "owner": {},
      "sections": [
        null
      ],
      "lastModified": "2019-08-24T14:15:22Z",
      "status": 0
    }
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPageContentOwnerRow>
  <rows>
    <content/>
    <owner/>
    <sections/>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <status>0</status>
  </rows>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPageContentOwnerRow>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPageContentOwnerRow

reporterror

These endpoints provide the functionality to create a new error report in the TERMINALFOUR system.

create

POST /report/error

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

downloadReport

GET /report/error/download/{id}

Parameters

Name In Type Required Description
id path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /report/error/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPageRow>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPageRow>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPageRow

reportnavigationSearch

These endpoints provide the functionality for generating a navigation object report.

createReport

POST /report/navigationSearch

Example responses

200 Response

{
  "property1": {
    "id": "string"
  },
  "property2": {
    "id": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <id>string</id>
</property1>
<property2>
  <id>string</id>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

downloadReport

POST /report/navigationSearch/download/{id}

Body parameter

{
  "property1": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "property2": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  }
}

Parameters

Name In Type Required Description
id path integer(int32) true none
body body object false none

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /report/navigationSearch/{keys}

Parameters

Name In Type Required Description
keys path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "property1": {
    "rows": [
      {}
    ],
    "pagingInfo": {
      "searchString": "string",
      "currentPage": 0,
      "pageSize": 0,
      "sortField": "string",
      "sortOrder": "[",
      "totalPages": 0,
      "totalRows": 0,
      "firstElementIndex": 0,
      "lastElementIndex": 0,
      "totalRowsInReport": 0
    },
    "details": {},
    "totalPages": 0,
    "sortOrder": "ASC",
    "pageSize": 0,
    "currentPage": 0,
    "searchString": "string",
    "sortField": "string",
    "firstElementIndex": 0,
    "totalRowsInReport": 0,
    "lastElementIndex": 0
  },
  "property2": {
    "rows": [
      {}
    ],
    "pagingInfo": {
      "searchString": "string",
      "currentPage": 0,
      "pageSize": 0,
      "sortField": "string",
      "sortOrder": "[",
      "totalPages": 0,
      "totalRows": 0,
      "firstElementIndex": 0,
      "lastElementIndex": 0,
      "totalRowsInReport": 0
    },
    "details": {},
    "totalPages": 0,
    "sortOrder": "ASC",
    "pageSize": 0,
    "currentPage": 0,
    "searchString": "string",
    "sortField": "string",
    "firstElementIndex": 0,
    "totalRowsInReport": 0,
    "lastElementIndex": 0
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>[</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</property1>
<property2>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>[</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

reportpublish

These endpoints provide the functionality to interact with the Publish reports.

createReport

POST /report/publish

Example responses

200 Response

{
  "property1": {
    "id": "string"
  },
  "property2": {
    "id": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <id>string</id>
</property1>
<property2>
  <id>string</id>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

createDetails

POST /report/publish/details

Example responses

200 Response

{
  "property1": {
    "id": "string"
  },
  "property2": {
    "id": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <id>string</id>
</property1>
<property2>
  <id>string</id>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

downloadLog

GET /report/publish/log/{id}

Parameters

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

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

downloadStatistics

GET /report/publish/statistics/{id}

Parameters

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

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /report/publish/{keys}

Parameters

Name In Type Required Description
keys path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "property1": {
    "rows": [
      {}
    ],
    "pagingInfo": {
      "searchString": "string",
      "currentPage": 0,
      "pageSize": 0,
      "sortField": "string",
      "sortOrder": "[",
      "totalPages": 0,
      "totalRows": 0,
      "firstElementIndex": 0,
      "lastElementIndex": 0,
      "totalRowsInReport": 0
    },
    "details": {},
    "totalPages": 0,
    "sortOrder": "ASC",
    "pageSize": 0,
    "currentPage": 0,
    "searchString": "string",
    "sortField": "string",
    "firstElementIndex": 0,
    "totalRowsInReport": 0,
    "lastElementIndex": 0
  },
  "property2": {
    "rows": [
      {}
    ],
    "pagingInfo": {
      "searchString": "string",
      "currentPage": 0,
      "pageSize": 0,
      "sortField": "string",
      "sortOrder": "[",
      "totalPages": 0,
      "totalRows": 0,
      "firstElementIndex": 0,
      "lastElementIndex": 0,
      "totalRowsInReport": 0
    },
    "details": {},
    "totalPages": 0,
    "sortOrder": "ASC",
    "pageSize": 0,
    "currentPage": 0,
    "searchString": "string",
    "sortField": "string",
    "firstElementIndex": 0,
    "totalRowsInReport": 0,
    "lastElementIndex": 0
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>[</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</property1>
<property2>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>[</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

reportsectionNavigationSearch

These endpoints provide the functionality for generating a navigation usage report by section.

createReport

POST /report/sectionNavigationSearch

Example responses

200 Response

{
  "property1": {
    "id": "string"
  },
  "property2": {
    "id": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <id>string</id>
</property1>
<property2>
  <id>string</id>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

downloadReport

POST /report/sectionNavigationSearch/download/{id}

Body parameter

{
  "property1": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "property2": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  }
}

Parameters

Name In Type Required Description
id path integer(int32) true none
body body object false none

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /report/sectionNavigationSearch/{keys}

Parameters

Name In Type Required Description
keys path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "property1": {
    "rows": [
      {}
    ],
    "pagingInfo": {
      "searchString": "string",
      "currentPage": 0,
      "pageSize": 0,
      "sortField": "string",
      "sortOrder": "[",
      "totalPages": 0,
      "totalRows": 0,
      "firstElementIndex": 0,
      "lastElementIndex": 0,
      "totalRowsInReport": 0
    },
    "details": {},
    "totalPages": 0,
    "sortOrder": "ASC",
    "pageSize": 0,
    "currentPage": 0,
    "searchString": "string",
    "sortField": "string",
    "firstElementIndex": 0,
    "totalRowsInReport": 0,
    "lastElementIndex": 0
  },
  "property2": {
    "rows": [
      {}
    ],
    "pagingInfo": {
      "searchString": "string",
      "currentPage": 0,
      "pageSize": 0,
      "sortField": "string",
      "sortOrder": "[",
      "totalPages": 0,
      "totalRows": 0,
      "firstElementIndex": 0,
      "lastElementIndex": 0,
      "totalRowsInReport": 0
    },
    "details": {},
    "totalPages": 0,
    "sortOrder": "ASC",
    "pageSize": 0,
    "currentPage": 0,
    "searchString": "string",
    "sortField": "string",
    "firstElementIndex": 0,
    "totalRowsInReport": 0,
    "lastElementIndex": 0
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>[</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</property1>
<property2>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>[</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

s3

delete

DELETE /s3

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK successful operation boolean

schedule

These endpoints describe the functionality for interacting with the TERMINALFOUR scheduler.

list

GET /schedule

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "status": 0,
    "creationDate": "2019-08-24T14:15:22Z",
    "nextDue": "2019-08-24T14:15:22Z",
    "fixedRate": true,
    "executionInterval": 0,
    "executionCount": 0,
    "alert": {
      "id": 0,
      "from": 0,
      "header": "string",
      "message": "string",
      "level": 0,
      "type": "[",
      "userRecipients": [
        null
      ],
      "groupRecipients": [
        null
      ],
      "dispatchMedia": [
        null
      ],
      "emailRecipients": [
        null
      ],
      "emailSender": "string",
      "attachments": [
        null
      ],
      "recipients": [
        null
      ]
    },
    "parameters": {
      "property1": {
        "scheduledJob": null,
        "key": null,
        "value": null
      },
      "property2": {
        "scheduledJob": null,
        "key": null,
        "value": null
      }
    },
    "maximumExecutions": 0,
    "jobDescription": "string",
    "jobName": "string",
    "jobKey": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<status>0</status>
<creationDate>2019-08-24T14:15:22Z</creationDate>
<nextDue>2019-08-24T14:15:22Z</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>[</type>
  <userRecipients/>
  <groupRecipients/>
  <dispatchMedia/>
  <emailRecipients/>
  <emailSender>string</emailSender>
  <attachments/>
  <recipients/>
</alert>
<parameters>
  <property1>
    <scheduledJob/>
    <key/>
    <value/>
  </property1>
  <property2>
    <scheduledJob/>
    <key/>
    <value/>
  </property2>
</parameters>
<maximumExecutions>0</maximumExecutions>
<jobDescription>string</jobDescription>
<jobName>string</jobName>
<jobKey>string</jobKey>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ScheduledJob] false none none
» maximumExecutions integer(int32) false none none
» jobDescription string false none none
» jobName string false none none
» jobKey string false none none

add

POST /schedule

Responses

Status Meaning Description Schema
default Default successful operation None

deleteMultiple

DELETE /schedule/delete/{ids}

Parameters

Name In Type Required Description
ids path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

getSchedulableJobItems

GET /schedule/items

Example responses

200 Response

[
  {
    "key": "string",
    "name": "string",
    "type": "string",
    "description": "string",
    "jobClass": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<key>string</key>
<name>string</name>
<type>string</type>
<description>string</description>
<jobClass>string</jobClass>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

reloadTasks

POST /schedule/reloadTasks

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /schedule/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "status": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "nextDue": "2019-08-24T14:15:22Z",
  "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": [
      "string"
    ],
    "recipients": [
      0
    ]
  },
  "parameters": {
    "property1": {
      "scheduledJob": {},
      "key": "string",
      "value": "string"
    },
    "property2": {
      "scheduledJob": {},
      "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-08-24T14:15:22Z</creationDate>
  <nextDue>2019-08-24T14:15:22Z</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>string</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

modify

PUT /schedule/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /schedule/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

search

These endpoints provide the web service operations for the section or content search.

search

POST /search

Example responses

200 Response

[
  {
    "type": "string",
    "id": 0,
    "lastModified": "string",
    "name": "string",
    "status": "string",
    "title": "string",
    "lastModifiedBy": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<type>string</type>
<id>0</id>
<lastModified>string</lastModified>
<name>string</name>
<status>string</status>
<title>string</title>
<lastModifiedBy>string</lastModifiedBy>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

section

These endpoints describe interacting with sections in the TERMINALFOUR system.

getChannels

GET /section/{id}/channels

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getParentChannels

GET /section/{id}/parentchannels

Parameters

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

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getOwner

GET /section/{id}/{language}/owner

Parameters

Name 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

setOwner

PUT /section/{id}/{language}/owner

Body parameter

{
  "id": 0,
  "type": "USER"
}

Parameters

Name In Type Required Description
id path integer(int32) true none
language path string true none
body body OwnerDTO false none

Responses

Status Meaning Description Schema
default Default successful operation None

sectionContentTypeReport

These endpoints describe operations for downloading the section content type search report.

createReport

POST /sectionContentTypeReport

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

downloadReport

GET /sectionContentTypeReport/download/{id}

Parameters

Name In Type Required Description
id path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /sectionContentTypeReport/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPage>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPage>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPage

sectionReport

Provides endpoints for the section search report functionality.

createPageLayoutReport

POST /sectionReport

Example responses

200 Response

{
  "id": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportID>
  <id>string</id>
</ReportID>

Responses

Status Meaning Description Schema
200 OK successful operation ReportID

downloadReport

GET /sectionReport/download/{id}

Parameters

Name In Type Required Description
id path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "url": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<ReportUrl>
  <url>string</url>
</ReportUrl>

Responses

Status Meaning Description Schema
200 OK successful operation ReportUrl

get

GET /sectionReport/{key}

Parameters

Name In Type Required Description
key path string true none
searchString query string false none
currentPage query integer(int32) false none
pageSize query integer(int32) false none
sortField query string false none
sortOrder query string false none

Enumerated Values

Parameter Value
sortOrder ASC
sortOrder DESC

Example responses

200 Response

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSetPage>
  <rows/>
  <pagingInfo>
    <searchString>string</searchString>
    <currentPage>0</currentPage>
    <pageSize>0</pageSize>
    <sortField>string</sortField>
    <sortOrder>ASC</sortOrder>
    <totalPages>0</totalPages>
    <totalRows>0</totalRows>
    <firstElementIndex>0</firstElementIndex>
    <lastElementIndex>0</lastElementIndex>
    <totalRowsInReport>0</totalRowsInReport>
  </pagingInfo>
  <details/>
  <totalPages>0</totalPages>
  <sortOrder>ASC</sortOrder>
  <pageSize>0</pageSize>
  <currentPage>0</currentPage>
  <searchString>string</searchString>
  <sortField>string</sortField>
  <firstElementIndex>0</firstElementIndex>
  <totalRowsInReport>0</totalRowsInReport>
  <lastElementIndex>0</lastElementIndex>
</ResultSetPage>

Responses

Status Meaning Description Schema
200 OK successful operation ResultSetPage

sitestructure

This endpoint provides operations to list the site structure plugins within the TERMINALFOUR system.

list

GET /sitestructure

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "plugin": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<plugin>string</plugin>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

smv

These endpoints provide the functionality for interacting with the special mapping values in the TERMINALFOUR system.

list

GET /smv

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

social

Provides the functionality for interacting with TERMINALFOUR social posters.

listAccounts

GET /social/account

Example responses

200 Response

[
  {
    "accountID": 0,
    "accountType": "string",
    "accountName": "string",
    "accountDescription": "string",
    "accountProperties": {
      "property1": "string",
      "property2": "string"
    },
    "accountPropertiesString": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<accountID>0</accountID>
<accountType>string</accountType>
<accountName>string</accountName>
<accountDescription>string</accountDescription>
<accountProperties>
  <property1>string</property1>
  <property2>string</property2>
</accountProperties>
<accountPropertiesString>string</accountPropertiesString>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

addSocialAccount

POST /social/account

Example responses

200 Response

{
  "accountID": 0,
  "accountType": "string",
  "accountName": "string",
  "accountDescription": "string",
  "accountProperties": {
    "property1": "string",
    "property2": "string"
  },
  "accountPropertiesString": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<SocialAccount>
  <accountID>0</accountID>
  <accountType>string</accountType>
  <accountName>string</accountName>
  <accountDescription>string</accountDescription>
  <accountProperties>
    <property1>string</property1>
    <property2>string</property2>
  </accountProperties>
  <accountPropertiesString>string</accountPropertiesString>
</SocialAccount>

Responses

Status Meaning Description Schema
200 OK successful operation SocialAccount

getAccount

GET /social/account/{socialAccountID}

Parameters

Name In Type Required Description
socialAccountID path integer(int32) true none

Example responses

200 Response

{
  "accountID": 0,
  "accountType": "string",
  "accountName": "string",
  "accountDescription": "string",
  "accountProperties": {
    "property1": "string",
    "property2": "string"
  },
  "accountPropertiesString": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<SocialAccount>
  <accountID>0</accountID>
  <accountType>string</accountType>
  <accountName>string</accountName>
  <accountDescription>string</accountDescription>
  <accountProperties>
    <property1>string</property1>
    <property2>string</property2>
  </accountProperties>
  <accountPropertiesString>string</accountPropertiesString>
</SocialAccount>

Responses

Status Meaning Description Schema
200 OK successful operation SocialAccount

modifyAccount

PUT /social/account/{socialAccountID}

Example responses

200 Response

{
  "accountID": 0,
  "accountType": "string",
  "accountName": "string",
  "accountDescription": "string",
  "accountProperties": {
    "property1": "string",
    "property2": "string"
  },
  "accountPropertiesString": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<SocialAccount>
  <accountID>0</accountID>
  <accountType>string</accountType>
  <accountName>string</accountName>
  <accountDescription>string</accountDescription>
  <accountProperties>
    <property1>string</property1>
    <property2>string</property2>
  </accountProperties>
  <accountPropertiesString>string</accountPropertiesString>
</SocialAccount>

Responses

Status Meaning Description Schema
200 OK successful operation SocialAccount

deleteAccount

DELETE /social/account/{socialAccountID}

Parameters

Name In Type Required Description
socialAccountID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

status

GET /social/checkLive

Parameters

Name In Type Required Description
url query string false none

Example responses

200 Response

true

Responses

Status Meaning Description Schema
200 OK successful operation boolean

configuration

GET /social/configuration

Example responses

200 Response

{
  "property1": "string",
  "property2": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>string</property1>
<property2>string</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties string false none none

modifyConfiguration

POST /social/configuration

Example responses

200 Response

{
  "property1": "string",
  "property2": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>string</property1>
<property2>string</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties string false none none

generateAuthURL

GET /social/generateAuthURL/{socialAccountID}

Parameters

Name In Type Required Description
socialAccountID path integer(int32) true none

Example responses

200 Response

{
  "property1": "string",
  "property2": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>string</property1>
<property2>string</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties string false none none

listNetworks

GET /social/network

Example responses

200 Response

[
  {
    "networkName": "string",
    "defaultResource": "string",
    "callbackParams": {
      "property1": "string",
      "property2": "string"
    },
    "configName": "string",
    "networkCallbackParam": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<networkName>string</networkName>
<defaultResource>string</defaultResource>
<callbackParams>
  <property1>string</property1>
  <property2>string</property2>
</callbackParams>
<configName>string</configName>
<networkCallbackParam>string</networkCallbackParam>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

listPosts

GET /social/post

Example responses

200 Response

[
  {
    "postID": 0,
    "socialAccount": {
      "accountID": 0,
      "accountType": "string",
      "accountName": "string",
      "accountDescription": "string",
      "accountProperties": {},
      "accountPropertiesString": "string"
    },
    "contentID": 0,
    "createdDate": "2019-08-24T14:15:22Z",
    "postedDate": "2019-08-24T14:15:22Z",
    "filename": "string",
    "baseURL": "string",
    "status": "sent",
    "postProperties": {
      "property1": "string",
      "property2": "string"
    },
    "postText": "string",
    "postDisplayText": "string",
    "postPropertiesString": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<postID>0</postID>
<socialAccount>
  <accountID>0</accountID>
  <accountType>string</accountType>
  <accountName>string</accountName>
  <accountDescription>string</accountDescription>
  <accountProperties/>
  <accountPropertiesString>string</accountPropertiesString>
</socialAccount>
<contentID>0</contentID>
<createdDate>2019-08-24T14:15:22Z</createdDate>
<postedDate>2019-08-24T14:15:22Z</postedDate>
<filename>string</filename>
<baseURL>string</baseURL>
<status>sent</status>
<postProperties>
  <property1>string</property1>
  <property2>string</property2>
</postProperties>
<postText>string</postText>
<postDisplayText>string</postDisplayText>
<postPropertiesString>string</postPropertiesString>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

create

POST /social/post

Responses

Status Meaning Description Schema
default Default successful operation None

sendPost

GET /social/post/send/{socialPostID}

Parameters

Name In Type Required Description
socialPostID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

getPost

GET /social/post/{socialPostID}

Parameters

Name In Type Required Description
socialPostID path integer(int32) true none

Example responses

200 Response

{
  "postID": 0,
  "socialAccount": {
    "accountID": 0,
    "accountType": "string",
    "accountName": "string",
    "accountDescription": "string",
    "accountProperties": {
      "property1": "string",
      "property2": "string"
    },
    "accountPropertiesString": "string"
  },
  "contentID": 0,
  "createdDate": "2019-08-24T14:15:22Z",
  "postedDate": "2019-08-24T14:15:22Z",
  "filename": "string",
  "baseURL": "string",
  "status": "sent",
  "postProperties": {
    "property1": "string",
    "property2": "string"
  },
  "postText": "string",
  "postDisplayText": "string",
  "postPropertiesString": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<socialpost>
  <postID>0</postID>
  <socialAccount>
    <accountID>0</accountID>
    <accountType>string</accountType>
    <accountName>string</accountName>
    <accountDescription>string</accountDescription>
    <accountProperties>
      <property1>string</property1>
      <property2>string</property2>
    </accountProperties>
    <accountPropertiesString>string</accountPropertiesString>
  </socialAccount>
  <contentID>0</contentID>
  <createdDate>2019-08-24T14:15:22Z</createdDate>
  <postedDate>2019-08-24T14:15:22Z</postedDate>
  <filename>string</filename>
  <baseURL>string</baseURL>
  <status>sent</status>
  <postProperties>
    <property1>string</property1>
    <property2>string</property2>
  </postProperties>
  <postText>string</postText>
  <postDisplayText>string</postDisplayText>
  <postPropertiesString>string</postPropertiesString>
</socialpost>

Responses

Status Meaning Description Schema
200 OK successful operation SocialPost

deletePost

DELETE /social/post/{socialPostID}

Parameters

Name In Type Required Description
socialPostID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

removeAuth

GET /social/removeAuth/{socialAccountID}

Parameters

Name In Type Required Description
socialAccountID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

spelling

Provides the spell checker functionality for the TERMINALFOUR system.

checkSpelling

POST /spelling

Example responses

200 Response

{
  "property1": [
    "string"
  ],
  "property2": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties [string] false none none

handleRequest

POST /spelling/tinymce

Body parameter

method: string
text: string
lang: string
word: string

Parameters

Name In Type Required Description
body body object false none
» method body string false none
» text body string false none
» lang body string false none
» word body string false none

Example responses

200 Response

{}

Responses

Status Meaning Description Schema
200 OK successful operation TinyMceResponse

ssl

These endpoints provide the functionality for interacting with TERMINALFOUR server side links.

PUT /ssl

Example responses

200 Response

{
  "id": 0,
  "fromSection": 0,
  "toSection": 0,
  "fromContent": 0,
  "toContent": 0,
  "linkText": "string",
  "language": "string",
  "toLanguage": "string",
  "attributes": {
    "property1": "string",
    "property2": "string"
  },
  "path": "string",
  "fromContentName": "string",
  "fromSectionPath": "string",
  "active": true,
  "broken": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<serversidelink>
  <id>0</id>
  <fromSection>0</fromSection>
  <toSection>0</toSection>
  <fromContent>0</fromContent>
  <toContent>0</toContent>
  <linkText>string</linkText>
  <language>string</language>
  <toLanguage>string</toLanguage>
  <attributes>
    <property1>string</property1>
    <property2>string</property2>
  </attributes>
  <path>string</path>
  <fromContentName>string</fromContentName>
  <fromSectionPath>string</fromSectionPath>
  <active>true</active>
  <broken>true</broken>
</serversidelink>
Status Meaning Description Schema
200 OK successful operation ServerSideLinkDTO

DELETE /ssl

Status Meaning Description Schema
default Default successful operation None

PUT /ssl/{id}

Example responses

200 Response

{
  "id": 0,
  "fromSection": 0,
  "toSection": 0,
  "fromContent": 0,
  "toContent": 0,
  "linkText": "string",
  "language": "string",
  "toLanguage": "string",
  "attributes": {
    "property1": "string",
    "property2": "string"
  },
  "path": "string",
  "fromContentName": "string",
  "fromSectionPath": "string",
  "active": true,
  "broken": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<serversidelink>
  <id>0</id>
  <fromSection>0</fromSection>
  <toSection>0</toSection>
  <fromContent>0</fromContent>
  <toContent>0</toContent>
  <linkText>string</linkText>
  <language>string</language>
  <toLanguage>string</toLanguage>
  <attributes>
    <property1>string</property1>
    <property2>string</property2>
  </attributes>
  <path>string</path>
  <fromContentName>string</fromContentName>
  <fromSectionPath>string</fromSectionPath>
  <active>true</active>
  <broken>true</broken>
</serversidelink>
Status Meaning Description Schema
200 OK successful operation ServerSideLinkDTO

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

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

Example responses

200 Response

{
  "id": 0,
  "fromSection": 0,
  "toSection": 0,
  "fromContent": 0,
  "toContent": 0,
  "linkText": "string",
  "language": "string",
  "toLanguage": "string",
  "attributes": {
    "property1": "string",
    "property2": "string"
  },
  "path": "string",
  "fromContentName": "string",
  "fromSectionPath": "string",
  "active": true,
  "broken": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<serversidelink>
  <id>0</id>
  <fromSection>0</fromSection>
  <toSection>0</toSection>
  <fromContent>0</fromContent>
  <toContent>0</toContent>
  <linkText>string</linkText>
  <language>string</language>
  <toLanguage>string</toLanguage>
  <attributes>
    <property1>string</property1>
    <property2>string</property2>
  </attributes>
  <path>string</path>
  <fromContentName>string</fromContentName>
  <fromSectionPath>string</fromSectionPath>
  <active>true</active>
  <broken>true</broken>
</serversidelink>
Status Meaning Description Schema
200 OK successful operation ServerSideLinkDTO

POST /ssl/{language}

Name In Type Required Description
language path string true none

Example responses

200 Response

{
  "property1": [
    {
      "id": 0,
      "fromSection": 0,
      "toSection": 0,
      "fromContent": 0,
      "toContent": 0,
      "linkText": "string",
      "language": "string",
      "toLanguage": "string",
      "attributes": {
        "property1": "string",
        "property2": "string"
      },
      "path": "string",
      "fromContentName": "string",
      "fromSectionPath": "string",
      "active": true,
      "broken": true
    }
  ],
  "property2": [
    {
      "id": 0,
      "fromSection": 0,
      "toSection": 0,
      "fromContent": 0,
      "toContent": 0,
      "linkText": "string",
      "language": "string",
      "toLanguage": "string",
      "attributes": {
        "property1": "string",
        "property2": "string"
      },
      "path": "string",
      "fromContentName": "string",
      "fromSectionPath": "string",
      "active": true,
      "broken": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <id>0</id>
  <fromSection>0</fromSection>
  <toSection>0</toSection>
  <fromContent>0</fromContent>
  <toContent>0</toContent>
  <linkText>string</linkText>
  <language>string</language>
  <toLanguage>string</toLanguage>
  <attributes>
    <property1>string</property1>
    <property2>string</property2>
  </attributes>
  <path>string</path>
  <fromContentName>string</fromContentName>
  <fromSectionPath>string</fromSectionPath>
  <active>true</active>
  <broken>true</broken>
</property1>
<property2>
  <id>0</id>
  <fromSection>0</fromSection>
  <toSection>0</toSection>
  <fromContent>0</fromContent>
  <toContent>0</toContent>
  <linkText>string</linkText>
  <language>string</language>
  <toLanguage>string</toLanguage>
  <attributes>
    <property1>string</property1>
    <property2>string</property2>
  </attributes>
  <path>string</path>
  <fromContentName>string</fromContentName>
  <fromSectionPath>string</fromSectionPath>
  <active>true</active>
  <broken>true</broken>
</property2>
Status Meaning Description Schema
200 OK successful operation Inline

Status Code 200

Name Type Required Restrictions Description
» additionalProperties [ServerSideLinkDTO] false none none

GET /ssl/{language}/{section}/{content}

Name In Type Required Description
language path string true none
section path integer(int32) true none
content path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "fromSection": 0,
    "toSection": 0,
    "fromContent": 0,
    "toContent": 0,
    "linkText": "string",
    "language": "string",
    "toLanguage": "string",
    "attributes": {
      "property1": "string",
      "property2": "string"
    },
    "path": "string",
    "fromContentName": "string",
    "fromSectionPath": "string",
    "active": true,
    "broken": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<fromSection>0</fromSection>
<toSection>0</toSection>
<fromContent>0</fromContent>
<toContent>0</toContent>
<linkText>string</linkText>
<language>string</language>
<toLanguage>string</toLanguage>
<attributes>
  <property1>string</property1>
  <property2>string</property2>
</attributes>
<path>string</path>
<fromContentName>string</fromContentName>
<fromSectionPath>string</fromSectionPath>
<active>true</active>
<broken>true</broken>
Status Meaning Description Schema
200 OK successful operation Inline

Status Code 200

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

syntaxType

These end points describe listing the syntax types used in the TERMINALFOUR system.

list

GET /syntaxType

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "mimeCode": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<mimeCode>string</mimeCode>

[{"id":0,"name":"string","mimeCode":"string"}]

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /syntaxType/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "mimeCode": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<syntaxType>
  <id>0</id>
  <name>string</name>
  <mimeCode>string</mimeCode>
</syntaxType>

{"id":0,"name":"string","mimeCode":"string"}

Responses

Status Meaning Description Schema
200 OK successful operation SyntaxType

task

These endpoints describe interacting with tasks in the TERMINALFOUR system.

add

POST /task

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /task/{taskId}/{taskType}

Parameters

Name In Type Required Description
taskId path string true none
taskType path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

getUpcomingTasks

GET /task/{taskType}

Parameters

Name In Type Required Description
taskType path string true none

Example responses

200 Response

[
  {
    "taskId": "string",
    "name": "string",
    "queuedTime": 0,
    "startTime": 0,
    "duration": "string",
    "type": "string",
    "isInprogress": true,
    "threadStatus": "string",
    "threadLevel": "string",
    "currentOutput": "string",
    "callStack": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<taskId>string</taskId>
<name>string</name>
<queuedTime>0</queuedTime>
<startTime>0</startTime>
<duration>string</duration>
<type>string</type>
<isInprogress>true</isInprogress>
<threadStatus>string</threadStatus>
<threadLevel>string</threadLevel>
<currentOutput>string</currentOutput>
<callStack>string</callStack>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

taskrepository

Provides the functionality to interact with the task repository service.

list

GET /task/repository/type/{type}

Parameters

Name In Type Required Description
type path string true none

Example responses

200 Response

[
  {
    "applicationEventPublisher": {},
    "writer": {
      "outputStream": {},
      "encoding": "string",
      "writer": {}
    },
    "status": "PENDING",
    "id": "string",
    "taskType": "string",
    "taskLevel": "string",
    "triggerStamp": "2019-08-24T14:15:22Z",
    "startedStamp": "2019-08-24T14:15:22Z",
    "completedStamp": "2019-08-24T14:15:22Z",
    "events": [
      {
        "source": null,
        "timestamp": null,
        "task": null,
        "description": null,
        "severity": null
      }
    ],
    "user": {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "emailAddress": "string",
      "defaultLang": "string",
      "localeCountryCode": "string",
      "localeLanguageCode": "string",
      "localeVariant": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "lastLoginDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "password": {},
      "defaultPreviewChannel": 0,
      "preferredHtmlEditor": 0,
      "extranetConsent": true,
      "extranetAccess": "string",
      "extranetConsentDatetime": "2019-08-24T14:15:22Z",
      "groups": [
        null
      ],
      "extensibleUserObjectContent": {},
      "sections": [
        null
      ],
      "userChannels": [
        null
      ],
      "locale": {},
      "fullName": "string",
      "deleted": true,
      "powerUser": true,
      "administrator": true,
      "authLevel": 0,
      "fullTinyMCELocaleCode": "string",
      "appliedPreviewChannel": 0,
      "propertyResourceBundle": {},
      "fullLocaleCode": "string"
    },
    "selectedLanguage": "string",
    "typeName": "string",
    "reportID": 0,
    "jobID": 0,
    "thread": {
      "name": "string",
      "priority": 0,
      "daemon": true,
      "contextClassLoader": {},
      "uncaughtExceptionHandler": {},
      "interrupted": true,
      "threadGroup": {},
      "stackTrace": [
        null
      ],
      "alive": true,
      "id": 0,
      "state": "["
    },
    "typeKeyword": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<applicationEventPublisher/>
<writer>
  <outputStream/>
  <encoding>string</encoding>
  <writer/>
</writer>
<status>PENDING</status>
<id>string</id>
<taskType>string</taskType>
<taskLevel>string</taskLevel>
<triggerStamp>2019-08-24T14:15:22Z</triggerStamp>
<startedStamp>2019-08-24T14:15:22Z</startedStamp>
<completedStamp>2019-08-24T14:15:22Z</completedStamp>
<events>
  <source/>
  <timestamp/>
  <task/>
  <description/>
  <severity/>
</events>
<user>
  <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-08-24T14:15:22Z</createDate>
  <lastLoginDate>2019-08-24T14:15:22Z</lastLoginDate>
  <enabled>true</enabled>
  <password/>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <preferredHtmlEditor>0</preferredHtmlEditor>
  <extranetConsent>true</extranetConsent>
  <extranetAccess>string</extranetAccess>
  <extranetConsentDatetime>2019-08-24T14:15:22Z</extranetConsentDatetime>
  <groups/>
  <extensibleUserObjectContent/>
  <sections/>
  <userChannels/>
  <locale/>
  <fullName>string</fullName>
  <deleted>true</deleted>
  <powerUser>true</powerUser>
  <administrator>true</administrator>
  <authLevel>0</authLevel>
  <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
  <appliedPreviewChannel>0</appliedPreviewChannel>
  <propertyResourceBundle/>
  <fullLocaleCode>string</fullLocaleCode>
</user>
<selectedLanguage>string</selectedLanguage>
<typeName>string</typeName>
<reportID>0</reportID>
<jobID>0</jobID>
<thread>
  <name>string</name>
  <priority>0</priority>
  <daemon>true</daemon>
  <contextClassLoader/>
  <uncaughtExceptionHandler/>
  <interrupted>true</interrupted>
  <threadGroup/>
  <stackTrace/>
  <alive>true</alive>
  <id>0</id>
  <state>[</state>
</thread>
<typeKeyword>string</typeKeyword>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Task] false none none
» status string false none none
» id string false none none
» taskType string false none none
» taskLevel string false none none
» triggerStamp string(date-time) false none none
» startedStamp string(date-time) false none none
» completedStamp string(date-time) false none none
»»»»»»»» priority integer(int32) false none none
»»»»»»»» disclaimer string false none none
»»»»»»»» publishRule integer(int32) false none none
»»»»»» contentVersions object false none none
»»»»»» languageCount integer(int32) false none none
»»»»» printSequence integer(int32) false none none
»»»»» sortLock string false none none
»»»»» sectionID integer(int32) false none none
»»»»» entityID integer(int32) false none none
»»»»» contentID integer(int32) false none none
»»»»»»» value string false none none
»»»»»»» language string false none none
»»»»»»» sectionID integer(int32) false none none
»»»»»»» metaTagName string false none none
»»»»»»» metaTagID integer(int32) false none none
»»»»» sectionID integer(int32) false none none
»»»»» pageLayoutID integer(int32) false none none
»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»» elementForFilename integer(int32) false none none
»»»»»» alias string false none none
»»»»»» directEditEnabled boolean false none none
»»»»»»»» sequence integer(int32) false none none
»»»»»»» restricted boolean false none none
»»»»»» duplicate boolean false none none
»»»»»» type integer(int32) false none none
»»»»»» sectionID integer(int32) false none none
»»»»»» minAuthLevel integer(int32) false none none
»»»»» scope integer(int32) false none none
»»»»» contentTypeID integer(int32) false none none
»»»» sortLock string false none none
»»» language string false none none
»»» name string false none none
»»» owner integer(int32) false none none
»»» id integer(int32) false none none
»» fullLocaleCode string false none none
» selectedLanguage string false none none
» typeName string false none none
» reportID integer(int32) false none none
» jobID integer(int32) false none none
»»» registeredAsParallelCapable boolean false none none
»»» definedPackages [Package] false none none
»» stackTrace [StackTraceElement] false none none
» typeKeyword string false none none

Enumerated Values

Property Value
status PENDING
status CANCELLED
status RUNNING
status FAILED
status COMPLETED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

add

POST /task/repository

Responses

Status Meaning Description Schema
default Default successful operation None

deleteMultiple

DELETE /task/repository/delete/{ids}

Parameters

Name In Type Required Description
ids path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /task/repository/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
  "applicationEventPublisher": {},
  "writer": {
    "outputStream": {},
    "encoding": "string",
    "writer": {}
  },
  "status": "PENDING",
  "id": "string",
  "taskType": "string",
  "taskLevel": "string",
  "triggerStamp": "2019-08-24T14:15:22Z",
  "startedStamp": "2019-08-24T14:15:22Z",
  "completedStamp": "2019-08-24T14:15:22Z",
  "events": [
    {
      "source": {},
      "timestamp": 0,
      "task": {},
      "description": "string",
      "severity": "["
    }
  ],
  "user": {
    "id": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string",
    "defaultLang": "string",
    "localeCountryCode": "string",
    "localeLanguageCode": "string",
    "localeVariant": "string",
    "createDate": "2019-08-24T14:15:22Z",
    "lastLoginDate": "2019-08-24T14:15:22Z",
    "enabled": true,
    "password": {
      "salt": null,
      "hashedPassword": null,
      "hashIterations": null
    },
    "defaultPreviewChannel": 0,
    "preferredHtmlEditor": 0,
    "extranetConsent": true,
    "extranetAccess": "string",
    "extranetConsentDatetime": "2019-08-24T14:15:22Z",
    "groups": [
      {}
    ],
    "extensibleUserObjectContent": {
      "metaData": null,
      "elements": null,
      "language": null,
      "name": null,
      "owner": null,
      "id": null,
      "version": null,
      "lastModified": null,
      "status": null,
      "sections": null,
      "channelIDs": null,
      "contentTypeID": null,
      "expiryDate": null,
      "sectionIDs": null,
      "archiveSection": null,
      "reviewDate": null,
      "publishDate": null,
      "elementCount": null,
      "lastModifiedBy": null,
      "previousVersion": null
    },
    "sections": [
      {}
    ],
    "userChannels": [
      {}
    ],
    "locale": {
      "language": null,
      "displayName": null,
      "script": null,
      "country": null,
      "variant": null,
      "extensionKeys": null,
      "unicodeLocaleAttributes": null,
      "unicodeLocaleKeys": null,
      "iso3Language": null,
      "iso3Country": null,
      "displayLanguage": null,
      "displayScript": null,
      "displayCountry": null,
      "displayVariant": null
    },
    "fullName": "string",
    "deleted": true,
    "powerUser": true,
    "administrator": true,
    "authLevel": 0,
    "fullTinyMCELocaleCode": "string",
    "appliedPreviewChannel": 0,
    "propertyResourceBundle": {
      "locale": null,
      "keys": null,
      "baseBundleName": null
    },
    "fullLocaleCode": "string"
  },
  "selectedLanguage": "string",
  "typeName": "string",
  "reportID": 0,
  "jobID": 0,
  "thread": {
    "name": "string",
    "priority": 0,
    "daemon": true,
    "contextClassLoader": {
      "parent": null,
      "name": null,
      "unnamedModule": null,
      "registeredAsParallelCapable": null,
      "definedPackages": null
    },
    "uncaughtExceptionHandler": {},
    "interrupted": true,
    "threadGroup": {
      "parent": null,
      "name": null,
      "maxPriority": null,
      "destroyed": null,
      "daemon": null
    },
    "stackTrace": [
      {}
    ],
    "alive": true,
    "id": 0,
    "state": "NEW"
  },
  "typeKeyword": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<Task>
  <applicationEventPublisher/>
  <writer>
    <outputStream/>
    <encoding>string</encoding>
    <writer/>
  </writer>
  <status>PENDING</status>
  <id>string</id>
  <taskType>string</taskType>
  <taskLevel>string</taskLevel>
  <triggerStamp>2019-08-24T14:15:22Z</triggerStamp>
  <startedStamp>2019-08-24T14:15:22Z</startedStamp>
  <completedStamp>2019-08-24T14:15:22Z</completedStamp>
  <events>
    <source/>
    <timestamp>0</timestamp>
    <task/>
    <description>string</description>
    <severity>[</severity>
  </events>
  <user>
    <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-08-24T14:15:22Z</createDate>
    <lastLoginDate>2019-08-24T14:15:22Z</lastLoginDate>
    <enabled>true</enabled>
    <password>
      <salt/>
      <hashedPassword/>
      <hashIterations/>
    </password>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-08-24T14:15:22Z</extranetConsentDatetime>
    <groups/>
    <extensibleUserObjectContent>
      <metaData/>
      <elements/>
      <language/>
      <name/>
      <owner/>
      <id/>
      <version/>
      <lastModified/>
      <status/>
      <sections/>
      <channelIDs/>
      <contentTypeID/>
      <expiryDate/>
      <sectionIDs/>
      <archiveSection/>
      <reviewDate/>
      <publishDate/>
      <elementCount/>
      <lastModifiedBy/>
      <previousVersion/>
    </extensibleUserObjectContent>
    <sections/>
    <userChannels/>
    <locale>
      <language/>
      <displayName/>
      <script/>
      <country/>
      <variant/>
      <extensionKeys/>
      <unicodeLocaleAttributes/>
      <unicodeLocaleKeys/>
      <iso3Language/>
      <iso3Country/>
      <displayLanguage/>
      <displayScript/>
      <displayCountry/>
      <displayVariant/>
    </locale>
    <fullName>string</fullName>
    <deleted>true</deleted>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
    <authLevel>0</authLevel>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle>
      <locale/>
      <keys/>
      <baseBundleName/>
    </propertyResourceBundle>
    <fullLocaleCode>string</fullLocaleCode>
  </user>
  <selectedLanguage>string</selectedLanguage>
  <typeName>string</typeName>
  <reportID>0</reportID>
  <jobID>0</jobID>
  <thread>
    <name>string</name>
    <priority>0</priority>
    <daemon>true</daemon>
    <contextClassLoader>
      <parent/>
      <name/>
      <unnamedModule/>
      <registeredAsParallelCapable/>
      <definedPackages/>
    </contextClassLoader>
    <uncaughtExceptionHandler/>
    <interrupted>true</interrupted>
    <threadGroup>
      <parent/>
      <name/>
      <maxPriority/>
      <destroyed/>
      <daemon/>
    </threadGroup>
    <stackTrace/>
    <alive>true</alive>
    <id>0</id>
    <state>NEW</state>
  </thread>
  <typeKeyword>string</typeKeyword>
</Task>

Responses

Status Meaning Description Schema
200 OK successful operation Task

delete

DELETE /task/repository/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

token

This functionality returns a temporary token to the front end.

create

GET /token

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK successful operation string

transfer

Provides endpoints for the Transfer Manager functionality.

list

GET /transfer

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "remoteHost": "string",
    "remoteRoot": "string",
    "transferType": 0,
    "channelID": 0,
    "cleanServer": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<remoteHost>string</remoteHost>
<remoteRoot>string</remoteRoot>
<transferType>0</transferType>
<channelID>0</channelID>
<cleanServer>true</cleanServer>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /transfer

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "transferType": 0,
  "channelID": 0,
  "remoteRoot": "string",
  "remoteHost": "string",
  "remotePort": 0,
  "username": "string",
  "password": "string",
  "backupDir": "string",
  "uploadExtensionsToIgnore": [
    "string"
  ],
  "uploadDirectoriesToIgnore": [
    "string"
  ],
  "cleanExtensionsToIgnore": [
    "string"
  ],
  "cleanDirectoriesToIgnore": [
    "string"
  ],
  "encryptionLevel": 0,
  "ignoreSubDirInUploadEnabled": true,
  "passiveModeEnabled": true,
  "cleanUpServerEnabled": true,
  "ignoreSubDirInCleanUpEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<TransferSiteDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <transferType>0</transferType>
  <channelID>0</channelID>
  <remoteRoot>string</remoteRoot>
  <remoteHost>string</remoteHost>
  <remotePort>0</remotePort>
  <username>string</username>
  <password>string</password>
  <backupDir>string</backupDir>
  <uploadExtensionsToIgnore>string</uploadExtensionsToIgnore>
  <uploadDirectoriesToIgnore>string</uploadDirectoriesToIgnore>
  <cleanExtensionsToIgnore>string</cleanExtensionsToIgnore>
  <cleanDirectoriesToIgnore>string</cleanDirectoriesToIgnore>
  <encryptionLevel>0</encryptionLevel>
  <ignoreSubDirInUploadEnabled>true</ignoreSubDirInUploadEnabled>
  <passiveModeEnabled>true</passiveModeEnabled>
  <cleanUpServerEnabled>true</cleanUpServerEnabled>
  <ignoreSubDirInCleanUpEnabled>true</ignoreSubDirInCleanUpEnabled>
</TransferSiteDTO>

Responses

Status Meaning Description Schema
200 OK successful operation TransferSiteDTO

listAllowedTransferSites

GET /transfer/allowedTranserSites

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "remoteHost": "string",
    "remoteRoot": "string",
    "transferType": 0,
    "channelID": 0,
    "cleanServer": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<remoteHost>string</remoteHost>
<remoteRoot>string</remoteRoot>
<transferType>0</transferType>
<channelID>0</channelID>
<cleanServer>true</cleanServer>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getCredentials

GET /transfer/credentials

Example responses

200 Response

{
  "channels": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<TransferCredential>
  <channels>
    <id>0</id>
    <description>string</description>
    <name>string</name>
    <parentID>0</parentID>
    <fullName>string</fullName>
  </channels>
</TransferCredential>

Responses

Status Meaning Description Schema
200 OK successful operation TransferCredential

modify

PUT /transfer/{id}

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "transferType": 0,
  "channelID": 0,
  "remoteRoot": "string",
  "remoteHost": "string",
  "remotePort": 0,
  "username": "string",
  "password": "string",
  "backupDir": "string",
  "uploadExtensionsToIgnore": [
    "string"
  ],
  "uploadDirectoriesToIgnore": [
    "string"
  ],
  "cleanExtensionsToIgnore": [
    "string"
  ],
  "cleanDirectoriesToIgnore": [
    "string"
  ],
  "encryptionLevel": 0,
  "ignoreSubDirInUploadEnabled": true,
  "passiveModeEnabled": true,
  "cleanUpServerEnabled": true,
  "ignoreSubDirInCleanUpEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<TransferSiteDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <transferType>0</transferType>
  <channelID>0</channelID>
  <remoteRoot>string</remoteRoot>
  <remoteHost>string</remoteHost>
  <remotePort>0</remotePort>
  <username>string</username>
  <password>string</password>
  <backupDir>string</backupDir>
  <uploadExtensionsToIgnore>string</uploadExtensionsToIgnore>
  <uploadDirectoriesToIgnore>string</uploadDirectoriesToIgnore>
  <cleanExtensionsToIgnore>string</cleanExtensionsToIgnore>
  <cleanDirectoriesToIgnore>string</cleanDirectoriesToIgnore>
  <encryptionLevel>0</encryptionLevel>
  <ignoreSubDirInUploadEnabled>true</ignoreSubDirInUploadEnabled>
  <passiveModeEnabled>true</passiveModeEnabled>
  <cleanUpServerEnabled>true</cleanUpServerEnabled>
  <ignoreSubDirInCleanUpEnabled>true</ignoreSubDirInCleanUpEnabled>
</TransferSiteDTO>

Responses

Status Meaning Description Schema
200 OK successful operation TransferSiteDTO

delete

DELETE /transfer/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /transfer/{transferSiteID}

Parameters

Name In Type Required Description
transferSiteID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "transferType": 0,
  "channelID": 0,
  "remoteRoot": "string",
  "remoteHost": "string",
  "remotePort": 0,
  "username": "string",
  "password": "string",
  "backupDir": "string",
  "uploadExtensionsToIgnore": [
    "string"
  ],
  "uploadDirectoriesToIgnore": [
    "string"
  ],
  "cleanExtensionsToIgnore": [
    "string"
  ],
  "cleanDirectoriesToIgnore": [
    "string"
  ],
  "encryptionLevel": 0,
  "ignoreSubDirInUploadEnabled": true,
  "passiveModeEnabled": true,
  "cleanUpServerEnabled": true,
  "ignoreSubDirInCleanUpEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<TransferSiteDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <transferType>0</transferType>
  <channelID>0</channelID>
  <remoteRoot>string</remoteRoot>
  <remoteHost>string</remoteHost>
  <remotePort>0</remotePort>
  <username>string</username>
  <password>string</password>
  <backupDir>string</backupDir>
  <uploadExtensionsToIgnore>string</uploadExtensionsToIgnore>
  <uploadDirectoriesToIgnore>string</uploadDirectoriesToIgnore>
  <cleanExtensionsToIgnore>string</cleanExtensionsToIgnore>
  <cleanDirectoriesToIgnore>string</cleanDirectoriesToIgnore>
  <encryptionLevel>0</encryptionLevel>
  <ignoreSubDirInUploadEnabled>true</ignoreSubDirInUploadEnabled>
  <passiveModeEnabled>true</passiveModeEnabled>
  <cleanUpServerEnabled>true</cleanUpServerEnabled>
  <ignoreSubDirInCleanUpEnabled>true</ignoreSubDirInCleanUpEnabled>
</TransferSiteDTO>

Responses

Status Meaning Description Schema
200 OK successful operation TransferSiteDTO

type

These endpoints describe operations on the types within the TERMINALFOUR system.

list

GET /type

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "listType": true
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<listType>true</listType>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /type/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "listType": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<TypeMetaDataDTO>
  <id>0</id>
  <name>string</name>
  <listType>true</listType>
</TypeMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation TypeMetaDataDTO

upload

Provides endpoints for the file upload functionality for the TERMINALFOUR system.

list

GET /upload

Example responses

200 Response

{
  "property1": {
    "code": "string",
    "name": "string"
  },
  "property2": {
    "code": "string",
    "name": "string"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <code>string</code>
  <name>string</name>
</property1>
<property2>
  <code>string</code>
  <name>string</name>
</property2>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

addUpload

POST /upload

Example responses

200 Response

{
  "code": "string",
  "name": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<FileUploadDTO>
  <code>string</code>
  <name>string</name>
</FileUploadDTO>

Responses

Status Meaning Description Schema
200 OK successful operation FileUploadDTO

user

Provides functionality for managing users in the TERMINALFOUR system.

list

GET /user/roles/{roles}

Parameters

Name In Type Required Description
roles path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string",
    "defaultLang": "string",
    "enabled": true,
    "deleted": true,
    "authLevel": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<username>string</username>
<firstName>string</firstName>
<lastName>string</lastName>
<emailAddress>string</emailAddress>
<defaultLang>string</defaultLang>
<enabled>true</enabled>
<deleted>true</deleted>
<authLevel>0</authLevel>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /user

Example responses

200 Response

{
  "id": 0,
  "userLevel": 0,
  "defaultPreviewChannel": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "userInterfaceLanguageId": "string",
  "password": "string",
  "extranetAccess": "string",
  "enabled": true,
  "htmlEditor": 0,
  "membershipGroups": 0,
  "groupUser": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "assignedChannelsList": [
    0
  ],
  "authenticationMappingList": [
    {
      "id": 0,
      "name": "string",
      "identifier": "string",
      "enabled": true
    }
  ],
  "userSectionDto": [
    {
      "id": 0,
      "path": "string",
      "parentID": 0,
      "group": true,
      "user": true,
      "media": true
    }
  ],
  "userExtensibleObjectDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  },
  "canModifyExtranetConsentEnabled": true,
  "extranetConsentEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserDTO>
  <id>0</id>
  <userLevel>0</userLevel>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <username>string</username>
  <firstName>string</firstName>
  <lastName>string</lastName>
  <emailAddress>string</emailAddress>
  <defaultLanguage>string</defaultLanguage>
  <userInterfaceLanguageId>string</userInterfaceLanguageId>
  <password>string</password>
  <extranetAccess>string</extranetAccess>
  <enabled>true</enabled>
  <htmlEditor>0</htmlEditor>
  <membershipGroups>0</membershipGroups>
  <groupUser>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
  </groupUser>
  <assignedChannelsList>0</assignedChannelsList>
  <authenticationMappingList>
    <id>0</id>
    <name>string</name>
    <identifier>string</identifier>
    <enabled>true</enabled>
  </authenticationMappingList>
  <userSectionDto>
    <id>0</id>
    <path>string</path>
    <parentID>0</parentID>
    <group>true</group>
    <user>true</user>
    <media>true</media>
  </userSectionDto>
  <userExtensibleObjectDto>
    <id>0</id>
    <contentTypeID>0</contentTypeID>
    <archiveSection>0</archiveSection>
    <publishDate>2019-08-24T14:15:22Z</publishDate>
    <reviewDate>2019-08-24T14:15:22Z</reviewDate>
    <expiryDate>2019-08-24T14:15:22Z</expiryDate>
    <language>string</language>
    <name>string</name>
    <alternativeLanguages/>
    <status>0</status>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <lastModifiedBy>0</lastModifiedBy>
    <lastModifierName>string</lastModifierName>
    <contentTypeName>string</contentTypeName>
    <contentTypeAlias>string</contentTypeAlias>
    <owner>
      <id/>
      <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/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </lock>
    <canPublishNow>true</canPublishNow>
    <canSaveAndApprove>true</canSaveAndApprove>
    <contentTypeAccess>0</contentTypeAccess>
    <contentTypeLock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </contentTypeLock>
    <elements>
      <property1/>
      <property2/>
    </elements>
    <contentType>
      <id/>
      <name/>
      <description/>
      <type/>
      <editable/>
      <primaryGroup/>
      <sharedGroups/>
      <alias/>
      <workflow/>
      <systemTemplate/>
      <sharedGroupCount/>
      <contentTypeElements/>
      <metaMapped/>
      <lock/>
      <minAuthLevel/>
      <enableDirectEdit/>
      <elementIdforFilename/>
      <warningMessage/>
      <sectionId/>
      <duplicate/>
      <duplicatedFromId/>
      <fullyAccessible/>
    </contentType>
    <types/>
    <insertAtIndex>0</insertAtIndex>
    <sortLock>TOP</sortLock>
    <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
    <locked>true</locked>
    <sectionIDs>0</sectionIDs>
  </userExtensibleObjectDto>
  <canModifyExtranetConsentEnabled>true</canModifyExtranetConsentEnabled>
  <extranetConsentEnabled>true</extranetConsentEnabled>
</UserDTO>

Responses

Status Meaning Description Schema
200 OK successful operation UserDTO

accessRights

GET /user/accessRights/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "userLevel": 0,
  "defaultPreviewChannel": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "userInterfaceLanguageId": "string",
  "password": "string",
  "extranetAccess": "string",
  "enabled": true,
  "htmlEditor": 0,
  "membershipGroups": 0,
  "groupUser": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "assignedChannelsList": [
    0
  ],
  "authenticationMappingList": [
    {
      "id": 0,
      "name": "string",
      "identifier": "string",
      "enabled": true
    }
  ],
  "userSectionDto": [
    {
      "id": 0,
      "path": "string",
      "parentID": 0,
      "group": true,
      "user": true,
      "media": true
    }
  ],
  "userExtensibleObjectDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  },
  "canModifyExtranetConsentEnabled": true,
  "extranetConsentEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserDTO>
  <id>0</id>
  <userLevel>0</userLevel>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <username>string</username>
  <firstName>string</firstName>
  <lastName>string</lastName>
  <emailAddress>string</emailAddress>
  <defaultLanguage>string</defaultLanguage>
  <userInterfaceLanguageId>string</userInterfaceLanguageId>
  <password>string</password>
  <extranetAccess>string</extranetAccess>
  <enabled>true</enabled>
  <htmlEditor>0</htmlEditor>
  <membershipGroups>0</membershipGroups>
  <groupUser>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
  </groupUser>
  <assignedChannelsList>0</assignedChannelsList>
  <authenticationMappingList>
    <id>0</id>
    <name>string</name>
    <identifier>string</identifier>
    <enabled>true</enabled>
  </authenticationMappingList>
  <userSectionDto>
    <id>0</id>
    <path>string</path>
    <parentID>0</parentID>
    <group>true</group>
    <user>true</user>
    <media>true</media>
  </userSectionDto>
  <userExtensibleObjectDto>
    <id>0</id>
    <contentTypeID>0</contentTypeID>
    <archiveSection>0</archiveSection>
    <publishDate>2019-08-24T14:15:22Z</publishDate>
    <reviewDate>2019-08-24T14:15:22Z</reviewDate>
    <expiryDate>2019-08-24T14:15:22Z</expiryDate>
    <language>string</language>
    <name>string</name>
    <alternativeLanguages/>
    <status>0</status>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <lastModifiedBy>0</lastModifiedBy>
    <lastModifierName>string</lastModifierName>
    <contentTypeName>string</contentTypeName>
    <contentTypeAlias>string</contentTypeAlias>
    <owner>
      <id/>
      <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/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </lock>
    <canPublishNow>true</canPublishNow>
    <canSaveAndApprove>true</canSaveAndApprove>
    <contentTypeAccess>0</contentTypeAccess>
    <contentTypeLock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </contentTypeLock>
    <elements>
      <property1/>
      <property2/>
    </elements>
    <contentType>
      <id/>
      <name/>
      <description/>
      <type/>
      <editable/>
      <primaryGroup/>
      <sharedGroups/>
      <alias/>
      <workflow/>
      <systemTemplate/>
      <sharedGroupCount/>
      <contentTypeElements/>
      <metaMapped/>
      <lock/>
      <minAuthLevel/>
      <enableDirectEdit/>
      <elementIdforFilename/>
      <warningMessage/>
      <sectionId/>
      <duplicate/>
      <duplicatedFromId/>
      <fullyAccessible/>
    </contentType>
    <types/>
    <insertAtIndex>0</insertAtIndex>
    <sortLock>TOP</sortLock>
    <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
    <locked>true</locked>
    <sectionIDs>0</sectionIDs>
  </userExtensibleObjectDto>
  <canModifyExtranetConsentEnabled>true</canModifyExtranetConsentEnabled>
  <extranetConsentEnabled>true</extranetConsentEnabled>
</UserDTO>

Responses

Status Meaning Description Schema
200 OK successful operation UserDTO

updateUserExtranetAccess

PUT /user/updateUserExtranetAccess/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

listSectionUsersAllowed

GET /user/userAllowed

Example responses

200 Response

[
  {
    "id": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string",
    "defaultLang": "string",
    "enabled": true,
    "deleted": true,
    "authLevel": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<username>string</username>
<firstName>string</firstName>
<lastName>string</lastName>
<emailAddress>string</emailAddress>
<defaultLang>string</defaultLang>
<enabled>true</enabled>
<deleted>true</deleted>
<authLevel>0</authLevel>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

listMediaLibraryUsersAllowed

GET /user/userAllowedMediaCategory

Example responses

200 Response

[
  {
    "id": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string",
    "defaultLang": "string",
    "enabled": true,
    "deleted": true,
    "authLevel": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<username>string</username>
<firstName>string</firstName>
<lastName>string</lastName>
<emailAddress>string</emailAddress>
<defaultLang>string</defaultLang>
<enabled>true</enabled>
<deleted>true</deleted>
<authLevel>0</authLevel>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

getBasicUserInformation

GET /user/userName/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "userLevel": 0,
  "defaultPreviewChannel": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "userInterfaceLanguageId": "string",
  "password": "string",
  "extranetAccess": "string",
  "enabled": true,
  "htmlEditor": 0,
  "membershipGroups": 0,
  "groupUser": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "assignedChannelsList": [
    0
  ],
  "authenticationMappingList": [
    {
      "id": 0,
      "name": "string",
      "identifier": "string",
      "enabled": true
    }
  ],
  "userSectionDto": [
    {
      "id": 0,
      "path": "string",
      "parentID": 0,
      "group": true,
      "user": true,
      "media": true
    }
  ],
  "userExtensibleObjectDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  },
  "canModifyExtranetConsentEnabled": true,
  "extranetConsentEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserDTO>
  <id>0</id>
  <userLevel>0</userLevel>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <username>string</username>
  <firstName>string</firstName>
  <lastName>string</lastName>
  <emailAddress>string</emailAddress>
  <defaultLanguage>string</defaultLanguage>
  <userInterfaceLanguageId>string</userInterfaceLanguageId>
  <password>string</password>
  <extranetAccess>string</extranetAccess>
  <enabled>true</enabled>
  <htmlEditor>0</htmlEditor>
  <membershipGroups>0</membershipGroups>
  <groupUser>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
  </groupUser>
  <assignedChannelsList>0</assignedChannelsList>
  <authenticationMappingList>
    <id>0</id>
    <name>string</name>
    <identifier>string</identifier>
    <enabled>true</enabled>
  </authenticationMappingList>
  <userSectionDto>
    <id>0</id>
    <path>string</path>
    <parentID>0</parentID>
    <group>true</group>
    <user>true</user>
    <media>true</media>
  </userSectionDto>
  <userExtensibleObjectDto>
    <id>0</id>
    <contentTypeID>0</contentTypeID>
    <archiveSection>0</archiveSection>
    <publishDate>2019-08-24T14:15:22Z</publishDate>
    <reviewDate>2019-08-24T14:15:22Z</reviewDate>
    <expiryDate>2019-08-24T14:15:22Z</expiryDate>
    <language>string</language>
    <name>string</name>
    <alternativeLanguages/>
    <status>0</status>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <lastModifiedBy>0</lastModifiedBy>
    <lastModifierName>string</lastModifierName>
    <contentTypeName>string</contentTypeName>
    <contentTypeAlias>string</contentTypeAlias>
    <owner>
      <id/>
      <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/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </lock>
    <canPublishNow>true</canPublishNow>
    <canSaveAndApprove>true</canSaveAndApprove>
    <contentTypeAccess>0</contentTypeAccess>
    <contentTypeLock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </contentTypeLock>
    <elements>
      <property1/>
      <property2/>
    </elements>
    <contentType>
      <id/>
      <name/>
      <description/>
      <type/>
      <editable/>
      <primaryGroup/>
      <sharedGroups/>
      <alias/>
      <workflow/>
      <systemTemplate/>
      <sharedGroupCount/>
      <contentTypeElements/>
      <metaMapped/>
      <lock/>
      <minAuthLevel/>
      <enableDirectEdit/>
      <elementIdforFilename/>
      <warningMessage/>
      <sectionId/>
      <duplicate/>
      <duplicatedFromId/>
      <fullyAccessible/>
    </contentType>
    <types/>
    <insertAtIndex>0</insertAtIndex>
    <sortLock>TOP</sortLock>
    <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
    <locked>true</locked>
    <sectionIDs>0</sectionIDs>
  </userExtensibleObjectDto>
  <canModifyExtranetConsentEnabled>true</canModifyExtranetConsentEnabled>
  <extranetConsentEnabled>true</extranetConsentEnabled>
</UserDTO>

Responses

Status Meaning Description Schema
200 OK successful operation UserDTO

get

GET /user/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "userLevel": 0,
  "defaultPreviewChannel": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "userInterfaceLanguageId": "string",
  "password": "string",
  "extranetAccess": "string",
  "enabled": true,
  "htmlEditor": 0,
  "membershipGroups": 0,
  "groupUser": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "assignedChannelsList": [
    0
  ],
  "authenticationMappingList": [
    {
      "id": 0,
      "name": "string",
      "identifier": "string",
      "enabled": true
    }
  ],
  "userSectionDto": [
    {
      "id": 0,
      "path": "string",
      "parentID": 0,
      "group": true,
      "user": true,
      "media": true
    }
  ],
  "userExtensibleObjectDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  },
  "canModifyExtranetConsentEnabled": true,
  "extranetConsentEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserDTO>
  <id>0</id>
  <userLevel>0</userLevel>
  <defaultPreviewChannel>0</defaultPreviewChannel>
  <username>string</username>
  <firstName>string</firstName>
  <lastName>string</lastName>
  <emailAddress>string</emailAddress>
  <defaultLanguage>string</defaultLanguage>
  <userInterfaceLanguageId>string</userInterfaceLanguageId>
  <password>string</password>
  <extranetAccess>string</extranetAccess>
  <enabled>true</enabled>
  <htmlEditor>0</htmlEditor>
  <membershipGroups>0</membershipGroups>
  <groupUser>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
  </groupUser>
  <assignedChannelsList>0</assignedChannelsList>
  <authenticationMappingList>
    <id>0</id>
    <name>string</name>
    <identifier>string</identifier>
    <enabled>true</enabled>
  </authenticationMappingList>
  <userSectionDto>
    <id>0</id>
    <path>string</path>
    <parentID>0</parentID>
    <group>true</group>
    <user>true</user>
    <media>true</media>
  </userSectionDto>
  <userExtensibleObjectDto>
    <id>0</id>
    <contentTypeID>0</contentTypeID>
    <archiveSection>0</archiveSection>
    <publishDate>2019-08-24T14:15:22Z</publishDate>
    <reviewDate>2019-08-24T14:15:22Z</reviewDate>
    <expiryDate>2019-08-24T14:15:22Z</expiryDate>
    <language>string</language>
    <name>string</name>
    <alternativeLanguages/>
    <status>0</status>
    <lastModified>2019-08-24T14:15:22Z</lastModified>
    <lastModifiedBy>0</lastModifiedBy>
    <lastModifierName>string</lastModifierName>
    <contentTypeName>string</contentTypeName>
    <contentTypeAlias>string</contentTypeAlias>
    <owner>
      <id/>
      <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/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </lock>
    <canPublishNow>true</canPublishNow>
    <canSaveAndApprove>true</canSaveAndApprove>
    <contentTypeAccess>0</contentTypeAccess>
    <contentTypeLock>
      <assetID/>
      <assetType/>
      <lockType/>
      <expiry/>
      <owner/>
      <ownerName/>
      <currentUser/>
      <language/>
    </contentTypeLock>
    <elements>
      <property1/>
      <property2/>
    </elements>
    <contentType>
      <id/>
      <name/>
      <description/>
      <type/>
      <editable/>
      <primaryGroup/>
      <sharedGroups/>
      <alias/>
      <workflow/>
      <systemTemplate/>
      <sharedGroupCount/>
      <contentTypeElements/>
      <metaMapped/>
      <lock/>
      <minAuthLevel/>
      <enableDirectEdit/>
      <elementIdforFilename/>
      <warningMessage/>
      <sectionId/>
      <duplicate/>
      <duplicatedFromId/>
      <fullyAccessible/>
    </contentType>
    <types/>
    <insertAtIndex>0</insertAtIndex>
    <sortLock>TOP</sortLock>
    <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
    <locked>true</locked>
    <sectionIDs>0</sectionIDs>
  </userExtensibleObjectDto>
  <canModifyExtranetConsentEnabled>true</canModifyExtranetConsentEnabled>
  <extranetConsentEnabled>true</extranetConsentEnabled>
</UserDTO>

Responses

Status Meaning Description Schema
200 OK successful operation UserDTO

update

PUT /user/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /user/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

userdictionary

Provides the funcationality for interacting with the user defined dictionaries.

addWord

PUT /user/dictionary

Responses

Status Meaning Description Schema
default Default successful operation None

userSearch

Provides web service functionality to allow users to be searched for by the current logged in user.

getUsers

GET /userSearch

Parameters

Name In Type Required Description
allUsers query boolean false none
authLevel query integer(int32) false none
groupId query integer(int32) false none
searchTerm query string false none

Example responses

200 Response

{
  "userList": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "overLimit": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserSearchDTO>
  <userList>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <authLevel>0</authLevel>
    <emailAddress>string</emailAddress>
  </userList>
  <overLimit>true</overLimit>
</UserSearchDTO>

Responses

Status Meaning Description Schema
200 OK successful operation UserSearchDTO

getCredentials

GET /userSearch/credentials

Example responses

200 Response

{
  "authLevelEnabled": [
    {
      "authLevelDescription": "string",
      "authLevelId": 0,
      "accessRightsEnabled": true,
      "modifyEnabled": true,
      "eraseEnabled": true
    }
  ],
  "groupsAllowed": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "availableLocales": [
    {
      "id": "string",
      "description": "string",
      "localeLanguageCode": "string",
      "localeCountryCode": "string",
      "localeVariant": "string",
      "defaultLocale": true
    }
  ],
  "htmlEditors": [
    {
      "id": 0,
      "name": "string",
      "minimumAccessLevel": 0,
      "defaultEditor": true
    }
  ],
  "extranetAccessList": [
    {
      "value": "string",
      "description": "string",
      "defaultAccessLevel": true
    }
  ],
  "channels": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ],
  "authMethods": [
    {
      "id": 0,
      "name": "string",
      "identifier": "string",
      "enabled": true
    }
  ],
  "channelsSelect": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ],
  "userExtensibleObjectID": 0,
  "contentExtensibleUserObjectID": 0,
  "canAssignChannelsToModeratorsEnabled": true,
  "canDeleteUsersEnabled": true,
  "canAssignChannelsEnabled": true,
  "createNewUserEnabled": true,
  "canAddToOwngroupEnabled": true,
  "readOnlyAuthMethodsEnabled": true,
  "editUsersEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<UserCredentialsDTO>
  <authLevelEnabled>
    <authLevelDescription>string</authLevelDescription>
    <authLevelId>0</authLevelId>
    <accessRightsEnabled>true</accessRightsEnabled>
    <modifyEnabled>true</modifyEnabled>
    <eraseEnabled>true</eraseEnabled>
  </authLevelEnabled>
  <groupsAllowed>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
  </groupsAllowed>
  <availableLocales>
    <id>string</id>
    <description>string</description>
    <localeLanguageCode>string</localeLanguageCode>
    <localeCountryCode>string</localeCountryCode>
    <localeVariant>string</localeVariant>
    <defaultLocale>true</defaultLocale>
  </availableLocales>
  <htmlEditors>
    <id>0</id>
    <name>string</name>
    <minimumAccessLevel>0</minimumAccessLevel>
    <defaultEditor>true</defaultEditor>
  </htmlEditors>
  <extranetAccessList>
    <value>string</value>
    <description>string</description>
    <defaultAccessLevel>true</defaultAccessLevel>
  </extranetAccessList>
  <channels>
    <id>0</id>
    <description>string</description>
    <name>string</name>
    <parentID>0</parentID>
    <fullName>string</fullName>
  </channels>
  <authMethods>
    <id>0</id>
    <name>string</name>
    <identifier>string</identifier>
    <enabled>true</enabled>
  </authMethods>
  <channelsSelect>
    <id>0</id>
    <description>string</description>
    <name>string</name>
    <parentID>0</parentID>
    <fullName>string</fullName>
  </channelsSelect>
  <userExtensibleObjectID>0</userExtensibleObjectID>
  <contentExtensibleUserObjectID>0</contentExtensibleUserObjectID>
  <canAssignChannelsToModeratorsEnabled>true</canAssignChannelsToModeratorsEnabled>
  <canDeleteUsersEnabled>true</canDeleteUsersEnabled>
  <canAssignChannelsEnabled>true</canAssignChannelsEnabled>
  <createNewUserEnabled>true</createNewUserEnabled>
  <canAddToOwngroupEnabled>true</canAddToOwngroupEnabled>
  <readOnlyAuthMethodsEnabled>true</readOnlyAuthMethodsEnabled>
  <editUsersEnabled>true</editUsersEnabled>
</UserCredentialsDTO>

Responses

Status Meaning Description Schema
200 OK successful operation UserCredentialsDTO

validationrule

This functionality provides the web services for the validation rules for the front end.

get

GET /validationrule/{model}

Parameters

Name In Type Required Description
model path string true none

Example responses

200 Response

{
  "property1": [
    {
      "property1": {},
      "property2": {}
    }
  ],
  "property2": [
    {
      "property1": {},
      "property2": {}
    }
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<property1>
  <property1/>
  <property2/>
</property1>
<property2>
  <property1/>
  <property2/>
</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
»» additionalProperties object false none none

version

These endpoints describe operations on the versions for content within the TERMINALFOUR system.

get

GET /version/{id}/{language}

Parameters

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

Example responses

200 Response

[
  {
    "language": "string",
    "version": "string",
    "name": "string",
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifierName": "string",
    "owner": 0,
    "lastModifiedBy": 0,
    "previousVersion": "string",
    "status": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<language>string</language>
<version>string</version>
<name>string</name>
<lastModified>2019-08-24T14:15:22Z</lastModified>
<lastModifierName>string</lastModifierName>
<owner>0</owner>
<lastModifiedBy>0</lastModifiedBy>
<previousVersion>string</previousVersion>
<status>0</status>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

modify

PUT /version/{id}/{language}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

workflow

Web service endpoints for the TERMINALFOUR workflows functionality.

list

GET /workflow/step/{workflowID}

Parameters

Name In Type Required Description
workflowID path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "priority": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<priority>0</priority>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

add

POST /workflow/step/{workflowID}

Parameters

Name In Type Required Description
workflowID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "stepPriority": 0,
  "users": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "rejectTo": 0,
  "stepXID": 0,
  "differentWorkflowID": 0,
  "stepDay": 0,
  "stepHour": 0,
  "vote": 0,
  "getxModerators": 0,
  "activeModeration": true,
  "alertType": [
    0
  ],
  "alertConfig": 0,
  "restrictToEditors": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<StepEntityDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <stepPriority>0</stepPriority>
  <users>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <authLevel>0</authLevel>
    <emailAddress>string</emailAddress>
  </users>
  <groups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groups>
  <rejectTo>0</rejectTo>
  <stepXID>0</stepXID>
  <differentWorkflowID>0</differentWorkflowID>
  <stepDay>0</stepDay>
  <stepHour>0</stepHour>
  <vote>0</vote>
  <getxModerators>0</getxModerators>
  <activeModeration>true</activeModeration>
  <alertType>0</alertType>
  <alertConfig>0</alertConfig>
  <restrictToEditors>true</restrictToEditors>
</StepEntityDTO>

Responses

Status Meaning Description Schema
200 OK successful operation StepEntityDTO

update

PUT /workflow/{id}

Responses

Status Meaning Description Schema
default Default successful operation None

deleteStep

DELETE /workflow/step/{workflowID}/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

getStep

GET /workflow/step/{workflowID}/{stepID}

Parameters

Name In Type Required Description
workflowID path integer(int32) true none
stepID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "stepPriority": 0,
  "users": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "rejectTo": 0,
  "stepXID": 0,
  "differentWorkflowID": 0,
  "stepDay": 0,
  "stepHour": 0,
  "vote": 0,
  "getxModerators": 0,
  "activeModeration": true,
  "alertType": [
    0
  ],
  "alertConfig": 0,
  "restrictToEditors": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<StepEntityDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <stepPriority>0</stepPriority>
  <users>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <authLevel>0</authLevel>
    <emailAddress>string</emailAddress>
  </users>
  <groups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groups>
  <rejectTo>0</rejectTo>
  <stepXID>0</stepXID>
  <differentWorkflowID>0</differentWorkflowID>
  <stepDay>0</stepDay>
  <stepHour>0</stepHour>
  <vote>0</vote>
  <getxModerators>0</getxModerators>
  <activeModeration>true</activeModeration>
  <alertType>0</alertType>
  <alertConfig>0</alertConfig>
  <restrictToEditors>true</restrictToEditors>
</StepEntityDTO>

Responses

Status Meaning Description Schema
200 OK successful operation StepEntityDTO

listStepEntities

GET /workflow/stepsInformation/{workflowID}

Parameters

Name In Type Required Description
workflowID path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "users": [
      {
        "id": null,
        "username": null,
        "firstName": null,
        "lastName": null,
        "authLevel": null,
        "emailAddress": null
      }
    ],
    "groups": [
      {
        "id": null,
        "name": null,
        "description": null,
        "membersCount": null
      }
    ],
    "rejectTo": 0,
    "stepXID": 0,
    "differentWorkflowID": 0,
    "stepDay": 0,
    "stepHour": 0,
    "vote": 0,
    "getxModerators": 0,
    "alertType": [
      0
    ],
    "alertConfig": 0,
    "stepXName": "string",
    "differentWorkflowName": "string",
    "uniqueUsers": 0
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<users>
  <id/>
  <username/>
  <firstName/>
  <lastName/>
  <authLevel/>
  <emailAddress/>
</users>
<groups>
  <id/>
  <name/>
  <description/>
  <membersCount/>
</groups>
<rejectTo>0</rejectTo>
<stepXID>0</stepXID>
<differentWorkflowID>0</differentWorkflowID>
<stepDay>0</stepDay>
<stepHour>0</stepHour>
<vote>0</vote>
<getxModerators>0</getxModerators>
<alertType>0</alertType>
<alertConfig>0</alertConfig>
<stepXName>string</stepXName>
<differentWorkflowName>string</differentWorkflowName>
<uniqueUsers>0</uniqueUsers>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

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

get

GET /workflow/{id}

Parameters

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

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "groupAssetID": 0,
  "restricted": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<WorkflowEntityDTO>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <groupAssetID>0</groupAssetID>
  <restricted>true</restricted>
</WorkflowEntityDTO>

Responses

Status Meaning Description Schema
200 OK successful operation WorkflowEntityDTO

delete

DELETE /workflow/{id}

Parameters

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

Responses

Status Meaning Description Schema
default Default successful operation None

workflowSearch

Provides the functionality to get the workflow credentials from a workflow for a user.

getCredentials

GET /workflowSearch

Example responses

200 Response

{
  "listWorkflowGroup": [
    {
      "workflowMetaDataDTO": {},
      "groupName": "string",
      "id": 0,
      "canPerformActionsEnabled": true,
      "canCreateNewEnabled": true,
      "global": true
    }
  ],
  "groupAllowed": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "canCreateOnlyGroupAsset": true,
  "approvers": {
    "users": [
      {}
    ],
    "groups": [
      {}
    ]
  },
  "canCreateNewWorkflowEnabled": true
}

<?xml version="1.0" encoding="UTF-8" ?>
<WorkflowCredentialsDTO>
  <listWorkflowGroup>
    <workflowMetaDataDTO/>
    <groupName>string</groupName>
    <id>0</id>
    <canPerformActionsEnabled>true</canPerformActionsEnabled>
    <canCreateNewEnabled>true</canCreateNewEnabled>
    <global>true</global>
  </listWorkflowGroup>
  <groupAllowed>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <membersCount>0</membersCount>
    <groupSections/>
    <members/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <emailAddress>string</emailAddress>
    <children/>
    <groupChildren/>
    <ldap>true</ldap>
    <groupEnabled>true</groupEnabled>
  </groupAllowed>
  <canCreateOnlyGroupAsset>true</canCreateOnlyGroupAsset>
  <approvers>
    <users/>
    <groups/>
  </approvers>
  <canCreateNewWorkflowEnabled>true</canCreateNewWorkflowEnabled>
</WorkflowCredentialsDTO>

Responses

Status Meaning Description Schema
200 OK successful operation WorkflowCredentialsDTO

Schemas

APIKeyDTO

{
  "id": 0,
  "name": "string",
  "active": true,
  "deleted": true,
  "secret": [
    "string"
  ],
  "userId": 0,
  "lastModifiedBy": 0,
  "dateModified": "2019-08-24T14:15:22Z",
  "dateCreated": "2019-08-24T14:15:22Z",
  "invalidationDate": "2019-08-24T14:15:22Z",
  "expired": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
active boolean false none none
deleted boolean false none none
secret [string] false none none
userId integer(int32) false none none
lastModifiedBy integer(int32) false none none
dateModified string(date-time) false none none
dateCreated string(date-time) false none none
invalidationDate string(date-time) false none none
expired boolean false none none

AccessControlProfileView

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

AccessControlPropagateDTO

{
  "addGroupIds": [
    0
  ],
  "removeGroupIds": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
addGroupIds [integer] false none none
removeGroupIds [integer] false none none

Alert

{
  "id": 0,
  "from": 0,
  "header": "string",
  "message": "string",
  "level": 0,
  "type": "DEFAULT",
  "userRecipients": [
    0
  ],
  "groupRecipients": [
    0
  ],
  "dispatchMedia": [
    0
  ],
  "emailRecipients": [
    "string"
  ],
  "emailSender": "string",
  "attachments": [
    "string"
  ],
  "recipients": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
from integer(int32) false none none
header string false none none
message string false none none
level integer(int32) false none none
type string false none none
userRecipients [integer] false none none
groupRecipients [integer] false none none
dispatchMedia [integer] false none none
emailRecipients [string] false none none
emailSender string false none none
attachments [string] false none none
recipients [integer] false none none

Enumerated Values

Property Value
type DEFAULT
type SCHEDULE_ERROR

AnalyticsAccountChannel

{
  "id": {
    "accountID": 0,
    "channelID": 0,
    "language": "string"
  },
  "serviceID": 0,
  "language": "string",
  "accountID": 0,
  "channelID": 0
}

Properties

None

AnalyticsAccountChannelID

{
  "accountID": 0,
  "channelID": 0,
  "language": "string"
}

Properties

Name Type Required Restrictions Description
accountID integer(int32) false none none
channelID integer(int32) false none none
language string false none none

AnalyticsAccountDTO

{
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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
  },
  "childIDs": [
    0
  ],
  "assignedChannels": [
    {
      "id": {},
      "serviceID": 0,
      "language": "string",
      "accountID": 0,
      "channelID": 0
    }
  ],
  "details": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ]
}

Properties

None

AnalyticsAccountDetail

{
  "id": 0,
  "accountID": 0,
  "name": "string",
  "value": "string",
  "enabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
accountID integer(int32) false none none
name string false none none
value string false none none
enabled boolean false none none

AnalyticsAccountMetaData

{
  "id": 0,
  "serviceID": 0,
  "type": 0,
  "language": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "sequence": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
serviceID integer(int32) false none none
type integer(int32) false none none
language string false none none
name string false none none
description string false none none
enabled boolean false none none
sequence integer(int32) false none none

AnalyticsServiceDetail

{
  "id": 0,
  "serviceID": 0,
  "name": "string",
  "value": "string",
  "enabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
serviceID integer(int32) false none none
name string false none none
value string false none none
enabled boolean false none none

AnalyticsServiceMetaData

{
  "id": 0,
  "name": "string",
  "description": "string",
  "implClass": "string",
  "enabled": true,
  "default": true,
  "details": [
    {
      "id": 0,
      "serviceID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
implClass string false none none
enabled boolean false none none
default boolean false none none
details [AnalyticsServiceDetail] false none none

AnalyticsTotalUnique

{
  "date": "2019-08-24T14:15:22Z",
  "total": 0,
  "unique": 0,
  "dateString": "string"
}

Properties

Name Type Required Restrictions Description
date string(date-time) false none none
total integer(int32) false none none
unique integer(int32) false none none
dateString string false none none

Annotation

{}

Properties

None

ApplicationEventPublisher

{}

Properties

None

AppliedPageLayout

{
  "id": {
    "channel": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "section": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionID": 0,
    "channelName": "string",
    "channelID": 0
  },
  "sectionID": 0,
  "pageLayoutID": 0,
  "inheritablePageLayoutID": 0,
  "channel": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  },
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "channelName": "string",
  "channelID": 0
}

Properties

None

AppliedPageLayoutDTO

{
  "channelID": 0,
  "sectionID": 0,
  "pageLayoutID": 0,
  "inheritablePageLayoutID": 0
}

Properties

Name Type Required Restrictions Description
channelID integer(int32) false none none
sectionID integer(int32) false none none
pageLayoutID integer(int32) false none none
inheritablePageLayoutID integer(int32) false none none

AppliedPageLayoutPK

{
  "channel": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  },
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "sectionID": 0,
  "channelName": "string",
  "channelID": 0
}

Properties

None

AppliedPageLayoutsDTO

{
  "id": 0,
  "pageLayout": 0,
  "inheritedPageLayout": 0,
  "valid": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
pageLayout integer(int32) false none none
inheritedPageLayout integer(int32) false none none
valid boolean false none none

ApprovableContent

{
  "id": 0,
  "contentTypeId": 0,
  "language": "string",
  "version": "string",
  "name": "string",
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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": [
        null
      ],
      "viewUsers": [
        null
      ],
      "groups": [
        null
      ],
      "viewGroups": [
        null
      ],
      "contentSections": [
        null
      ],
      "sectionInfos": {},
      "mirrorSections": [
        null
      ],
      "links": {},
      "rootChannels": [
        null
      ],
      "appliedPageLayouts": [
        null
      ],
      "hierarchyMirrorAcOpt": {},
      "hierarchyMirrorMetadataOpt": {},
      "children": [
        null
      ],
      "contentTypeScopes": [
        null
      ],
      "cloneSource": {},
      "sectionPaths": {},
      "sortLock": "[",
      "parent": {},
      "mirrors": [
        null
      ],
      "root": true,
      "shown": true,
      "nextSequence": 0,
      "entityID": 0,
      "childOfMirrored": true,
      "metadataOption": 0,
      "workflowID": 0,
      "childOfMirror": true,
      "workflowName": "string",
      "workflow": {},
      "channelRoot": [
        null
      ],
      "languages": [
        null
      ],
      "channels": [
        null
      ],
      "pathMembers": [
        null
      ],
      "sectionSortMethod": 0,
      "contentSortMethod": 0,
      "contentsAndSequences": {},
      "parentWorkflowID": 0,
      "inheritedPageLayouts": {},
      "currentOrInheritedWorkflow": 0,
      "contentNextSequence": 0,
      "accessControlOption": 0,
      "parentID": 0,
      "mirror": true,
      "allNames": {},
      "languageCount": 0,
      "mirrorSource": {},
      "link": true,
      "mirrorSourceID": 0
    }
  ],
  "alreadyVoted": true,
  "hasAccessToContent": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
contentTypeId integer(int32) false none none
language string false none none
version string false none none
name string false none none
status integer(int32) false none none
lastModified string(date-time) false none none
lastModifiedBy string false none none
lastModifiedById integer(int32) false none none
ownerId integer(int32) false none none
owner string false none none

ApproveDto

{
  "comment": "string",
  "fastTrack": "string"
}

Properties

Name Type Required Restrictions Description
comment string false none none
fastTrack string false none none

ApproveableContentWorkflow

{
  "id": 0,
  "name": "string",
  "description": "string",
  "stepId": 0,
  "stepNumber": 0,
  "stepName": "string",
  "instanceId": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
stepId integer(int32) false none none
stepNumber integer(int32) false none none
stepName string false none none
instanceId integer(int32) false none none

AssetLockDTO

{
  "assetID": 0,
  "assetType": 0,
  "lockType": 0,
  "expiry": "2019-08-24T14:15:22Z",
  "owner": 0,
  "ownerName": "string",
  "currentUser": true,
  "language": "string"
}

Properties

Name Type Required Restrictions Description
assetID integer(int32) false none none
assetType integer(int32) false none none
lockType integer(int32) false none none
expiry string(date-time) false none none
owner integer(int32) false none none
ownerName string false none none
currentUser boolean false none none
language string false none none

AssetSharingInformation

{
  "ownershipLevel": 0,
  "group": {
    "id": 0,
    "name": "string",
    "description": "string",
    "emailAddress": "string",
    "createDate": "2019-08-24T14:15:22Z",
    "enabled": true,
    "ldap": true,
    "defaultChannel": 0,
    "deleted": true
  },
  "assetID": 0,
  "groupID": 0,
  "assetType": 0,
  "readLevel": 0,
  "groupName": "string"
}

Properties

Name Type Required Restrictions Description
ownershipLevel integer(int32) false none none

AuthenticationMethod

{
  "id": 0,
  "name": "string",
  "description": "string",
  "javaClass": "string",
  "enabled": true,
  "updateUserRecord": true,
  "authMethodMappings": {
    "property1": "string",
    "property2": "string"
  },
  "deactivateUserRecord": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
name string true none none
description string true none none
javaClass string true none none
enabled boolean true none none
updateUserRecord boolean true none none
authMethodMappings object false none none
» additionalProperties string false none none
deactivateUserRecord boolean true none none

AuthenticationMethodDTO

{
  "id": 0,
  "name": "string",
  "identifier": "string",
  "enabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
identifier string false none none
enabled boolean false none none

AutoMirrorContentConfigDTO

{
  "listID": 0,
  "listName": "string",
  "language": "string",
  "items": [
    {
      "id": 0,
      "name": "string",
      "sectionID": 0
    }
  ],
  "mirror": true
}

Properties

Name Type Required Restrictions Description
listID integer(int32) false none none
listName string false none none
language string false none none
items [AutoMirrorContentItemDTO] false none none

AutoMirrorContentItemDTO

{
  "id": 0,
  "name": "string",
  "sectionID": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
sectionID integer(int32) false none none

BookmarkDTO

{
  "id": 0,
  "description": "string",
  "url": "string",
  "icon": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
description string false none none
url string false none none
icon string false none none

BrokenLinksRow

{
  "content": {
    "id": 0,
    "text": "string",
    "language": "string"
  },
  "language": "string",
  "sections": [
    {
      "id": 0,
      "text": "string"
    }
  ],
  "type": "INTERNAL",
  "responseCode": 0,
  "errorMessage": "string",
  "url": "string",
  "contentTypeID": 0,
  "contentTypeElementIDs": [
    0
  ]
}

Properties

None

Cell

{
  "id": 0,
  "text": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
text string false none none

Channel

{
  "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": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  },
  "favIconID": 0,
  "pollIconID": 0,
  "accessControlConfigurationID": 0,
  "personalisationConfigurationID": 0,
  "publishReportLevel": 0,
  "pendingVersionOutputPath": "string",
  "pendingVersionBaseHref": "string",
  "pendingVersionSiteRoot": "string",
  "prePublishProcessorID": 0,
  "allowScriptsInDirectEdit": 0,
  "pxlFolder": "string",
  "languages": [
    {
      "code": "string",
      "name": "string",
      "charset": "string",
      "disclaimer": "string",
      "channels": [
        null
      ]
    }
  ],
  "microSites": [
    {
      "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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    }
  ],
  "permittedFileExtensions": [
    {
      "id": {},
      "priority": 0
    }
  ],
  "translationDisclaimers": [
    {
      "id": {},
      "disclaimer": "string"
    }
  ],
  "mediaPublishRules": [
    {
      "id": {},
      "publishRule": 0
    }
  ],
  "channelFullTextDisplayPeriod": {
    "id": 0,
    "enabled": true,
    "dateType": 0,
    "filterType": 0,
    "filter": "string",
    "period": 0,
    "periodUnit": 0,
    "channel": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    }
  },
  "channelUsers": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "emailAddress": "string",
      "defaultLang": "string",
      "localeCountryCode": "string",
      "localeLanguageCode": "string",
      "localeVariant": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "lastLoginDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "password": {},
      "defaultPreviewChannel": 0,
      "preferredHtmlEditor": 0,
      "extranetConsent": true,
      "extranetAccess": "string",
      "extranetConsentDatetime": "2019-08-24T14:15:22Z",
      "groups": [
        null
      ],
      "extensibleUserObjectContent": {},
      "sections": [
        null
      ],
      "userChannels": [
        null
      ],
      "locale": {},
      "fullName": "string",
      "deleted": true,
      "powerUser": true,
      "administrator": true,
      "authLevel": 0,
      "fullTinyMCELocaleCode": "string",
      "appliedPreviewChannel": 0,
      "propertyResourceBundle": {},
      "fullLocaleCode": "string"
    }
  ],
  "channelContents": [
    {
      "id": 0,
      "contentTypeID": 0,
      "archiveSection": 0,
      "publishDate": "2019-08-24T14:15:22Z",
      "reviewDate": "2019-08-24T14:15:22Z",
      "expiryDate": "2019-08-24T14:15:22Z",
      "contentChannels": [
        null
      ],
      "contentVersions": {},
      "cloneSource": {},
      "sections": [
        null
      ],
      "channelIDs": [
        null
      ],
      "sectionIDs": [
        null
      ],
      "languages": {},
      "languageIndependant": true,
      "allLanguageMetaData": {},
      "languageCount": 0
    }
  ],
  "mediaTypesWithPublishRuleCategory": [
    0
  ],
  "convertSpacesInSectionNameEnabled": true,
  "convertSpacesInRetainedFilenameEnabled": true,
  "channelCleanupEnabled": true,
  "personalisationEnabled": true,
  "accessControlEnabled": true,
  "fullTextDisplayPeriodValue": 0,
  "fullTextDisplayPeriodUnit": 0,
  "secondaryPublishEnabled": true,
  "overrideExtensionEnabled": true,
  "publishEmptySectionsEnabled": true,
  "convertSpacesInOutputURIEnabled": true,
  "parentID": 0,
  "contentIDs": [
    0
  ],
  "languageCodes": [
    "string"
  ],
  "microSite": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
type string false none none
defaultLanguage string false none none
rootSectionID integer(int32) false none none
fileOutputPath string false none none
indexFileName string false none none
baseHref string false none none
siteRoot string false none none
pathCaseModifier integer(int32) false none none
fullTextType string false none none
fullTextExtension string false none none
secondaryPublishLanguage string false none none
channelPublishURL string false none none

ChannelDTO

{
  "id": 0,
  "description": "string",
  "name": "string",
  "parentID": 0,
  "fullName": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
description string false none none
name string false none none
parentID integer(int32) false none none
fullName string false none none

ChannelFileExtension

{
  "id": {
    "channel": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "fileExtension": {
      "name": null,
      "description": null,
      "extension": null,
      "channelFileExtensions": null
    }
  },
  "priority": 0
}

Properties

None

ChannelFileExtensionDTO

{
  "channelID": 0,
  "extension": "string",
  "priority": 0
}

Properties

Name Type Required Restrictions Description
channelID integer(int32) false none none
extension string false none none
priority integer(int32) false none none

ChannelFileExtensionPK

{
  "channel": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  },
  "fileExtension": {
    "name": "string",
    "description": "string",
    "extension": "string",
    "channelFileExtensions": [
      {}
    ]
  }
}

Properties

None

ChannelFullTextDisplayPeriod

{
  "id": 0,
  "enabled": true,
  "dateType": 0,
  "filterType": 0,
  "filter": "string",
  "period": 0,
  "periodUnit": 0,
  "channel": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  }
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
enabled boolean false none none
dateType integer(int32) false none none
filterType integer(int32) false none none
filter string false none none
period integer(int32) false none none
periodUnit integer(int32) false none none

ChannelFullTextDisplayPeriodDTO

{
  "id": 0,
  "channelID": 0,
  "enabled": true,
  "dateType": 0,
  "filterType": 0,
  "filter": "string",
  "period": 0,
  "periodUnit": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
channelID integer(int32) false none none
enabled boolean false none none
dateType integer(int32) false none none
filterType integer(int32) false none none
filter string false none none
period integer(int32) false none none
periodUnit integer(int32) false none none

ChannelMetaData

{
  "id": 0,
  "name": "string",
  "description": "string",
  "pendingVersionOutputDir": "string",
  "rootSectionID": 0,
  "hasPendingVersion": true,
  "editable": true,
  "microSites": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "pendingVersionOutputDir": "string",
      "rootSectionID": 0,
      "hasPendingVersion": true,
      "editable": true,
      "microSites": [
        null
      ],
      "parentID": 0
    }
  ],
  "parentID": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
name string true none none
description string false none none
pendingVersionOutputDir string false none none
rootSectionID integer(int32) false none none
hasPendingVersion boolean false none none
editable boolean false none none
microSites [ChannelMetaData] false none none

ChannelPxlFolderDTO

{
  "value": "string",
  "inputIsValid": true
}

Properties

Name Type Required Restrictions Description
value string false none none
inputIsValid boolean false none none

ChannelSectionAssignmentDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

ClassLoader

{
  "parent": {
    "parent": {
      "parent": null,
      "name": null,
      "unnamedModule": null,
      "registeredAsParallelCapable": null,
      "definedPackages": null
    },
    "name": "string",
    "unnamedModule": {
      "layer": null,
      "name": null,
      "descriptor": null,
      "classLoader": null,
      "annotations": null,
      "declaredAnnotations": null,
      "named": null,
      "packages": null
    },
    "registeredAsParallelCapable": true,
    "definedPackages": [
      {}
    ]
  },
  "name": "string",
  "unnamedModule": {
    "layer": {},
    "name": "string",
    "descriptor": {
      "open": null,
      "automatic": null
    },
    "classLoader": {
      "parent": null,
      "name": null,
      "unnamedModule": null,
      "registeredAsParallelCapable": null,
      "definedPackages": null
    },
    "annotations": [
      {}
    ],
    "declaredAnnotations": [
      {}
    ],
    "named": true,
    "packages": [
      "string"
    ]
  },
  "registeredAsParallelCapable": true,
  "definedPackages": [
    {
      "name": "string",
      "annotations": [
        null
      ],
      "declaredAnnotations": [
        null
      ],
      "sealed": true,
      "specificationTitle": "string",
      "specificationVersion": "string",
      "specificationVendor": "string",
      "implementationTitle": "string",
      "implementationVersion": "string",
      "implementationVendor": "string"
    }
  ]
}

Properties

None

ClusteredServerDTO

{
  "serverName": "string",
  "sourcePort": 0,
  "destinationPort": 0,
  "useAsScheduledServer": true,
  "useAsSearchIndexServer": true,
  "newName": "string",
  "modified": true
}

Properties

Name Type Required Restrictions Description
serverName string true none none
sourcePort integer(int32) false none none
destinationPort integer(int32) false none none
useAsScheduledServer boolean false none none
useAsSearchIndexServer boolean false none none
newName string false none none
modified boolean false none none

CodeSnippet

{
  "code": "string",
  "markLine": 0,
  "firstLine": 0,
  "firstChar": 0,
  "lastChar": 0,
  "empty": true
}

Properties

Name Type Required Restrictions Description
code string false none none
markLine integer(int32) false none none
firstLine integer(int32) false none none
firstChar integer(int32) false none none
lastChar integer(int32) false none none
empty boolean false none none

Column

{
  "name": "string",
  "default": "string",
  "type": 0,
  "maxSize": 0,
  "unique": true,
  "indexed": true,
  "indexLength": 0,
  "primaryKey": true,
  "autoIncrement": true,
  "nullValuePermitted": true
}

Properties

Name Type Required Restrictions Description
name string false none none
default string false none none
type integer(int32) false none none
maxSize integer(int32) false none none
unique boolean false none none
indexed boolean false none none
indexLength integer(int32) false none none
primaryKey boolean false none none
autoIncrement boolean false none none
nullValuePermitted boolean false none none

CommentDto

{
  "comment": "string"
}

Properties

Name Type Required Restrictions Description
comment string false none none

ConfigurationOptionDTO

{
  "name": "string",
  "type": "string",
  "value": {},
  "valueList": [
    {}
  ],
  "valueMap": [
    {
      "property1": {},
      "property2": {}
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string false none none
type string false none none
value object false none none
valueList [object] false none none
valueMap [object] false none none
» additionalProperties object false none none

ConfigurationOptions

{
  "options": [
    {
      "name": "string",
      "type": "string",
      "value": {},
      "valueList": [
        null
      ],
      "valueMap": [
        null
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
options [ConfigurationOptionDTO] true none none

Content

{
  "metaData": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "contentChannels": [
      {}
    ],
    "contentVersions": {
      "property1": {},
      "property2": {}
    },
    "cloneSource": {
      "id": null,
      "contentTypeID": null,
      "archiveSection": null,
      "publishDate": null,
      "reviewDate": null,
      "expiryDate": null,
      "contentChannels": null,
      "contentVersions": null,
      "cloneSource": null,
      "sections": null,
      "channelIDs": null,
      "sectionIDs": null,
      "languages": null,
      "languageIndependant": null,
      "allLanguageMetaData": null,
      "languageCount": null
    },
    "sections": [
      {}
    ],
    "channelIDs": [
      0
    ],
    "sectionIDs": [
      0
    ],
    "languages": {},
    "languageIndependant": true,
    "allLanguageMetaData": {
      "property1": {},
      "property2": {}
    },
    "languageCount": 0
  },
  "elements": [
    {
      "name": "string",
      "alias": "string",
      "value": {},
      "size": 0,
      "null": true,
      "attributeNames": {},
      "text": true,
      "aliasName": "string",
      "streamable": true,
      "stream": {}
    }
  ],
  "language": "string",
  "name": "string",
  "owner": 0,
  "id": 0,
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "lastModified": "2019-08-24T14:15:22Z",
  "status": 0,
  "sections": [
    {
      "section": {},
      "content": {},
      "printSequence": 0,
      "sortLock": "[",
      "sectionID": 0,
      "entityID": 0,
      "contentID": 0
    }
  ],
  "channelIDs": [
    0
  ],
  "contentTypeID": 0,
  "expiryDate": "2019-08-24T14:15:22Z",
  "sectionIDs": [
    0
  ],
  "archiveSection": 0,
  "reviewDate": "2019-08-24T14:15:22Z",
  "publishDate": "2019-08-24T14:15:22Z",
  "elementCount": 0,
  "lastModifiedBy": 0,
  "previousVersion": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  }
}

Properties

None

ContentCell

{
  "id": 0,
  "text": "string",
  "language": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
text string false none none
language string false none none

ContentDTO

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
contentTypeID integer(int32) false none none
archiveSection integer(int32) false none none
publishDate string(date-time) false none none
reviewDate string(date-time) false none none
expiryDate string(date-time) false none none
language string false none none
name string false none none
alternativeLanguages [ContentNameTranslationsDTO] false none none

ContentDuplicateDTO

{
  "id": 0,
  "language": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
language string false none none
name string false none none

ContentElement

{
  "name": "string",
  "alias": "string",
  "value": {},
  "size": 0,
  "null": true,
  "attributeNames": {},
  "text": true,
  "aliasName": "string",
  "streamable": true,
  "stream": {}
}

Properties

Name Type Required Restrictions Description
name string false none none
alias string false none none
value object false none none
size integer(int64) false none none
null boolean false none none

ContentListing

{
  "id": 0,
  "name": "string",
  "language": "string",
  "sections": [
    {
      "id": 0,
      "level": 0,
      "status": 0,
      "printSequence": 0,
      "formSection": true,
      "archived": true,
      "users": [
        null
      ],
      "viewUsers": [
        null
      ],
      "groups": [
        null
      ],
      "viewGroups": [
        null
      ],
      "contentSections": [
        null
      ],
      "sectionInfos": {},
      "mirrorSections": [
        null
      ],
      "links": {},
      "rootChannels": [
        null
      ],
      "appliedPageLayouts": [
        null
      ],
      "hierarchyMirrorAcOpt": {},
      "hierarchyMirrorMetadataOpt": {},
      "children": [
        null
      ],
      "contentTypeScopes": [
        null
      ],
      "cloneSource": {},
      "sectionPaths": {},
      "sortLock": "[",
      "parent": {},
      "mirrors": [
        null
      ],
      "root": true,
      "shown": true,
      "nextSequence": 0,
      "entityID": 0,
      "childOfMirrored": true,
      "metadataOption": 0,
      "workflowID": 0,
      "childOfMirror": true,
      "workflowName": "string",
      "workflow": {},
      "channelRoot": [
        null
      ],
      "languages": [
        null
      ],
      "channels": [
        null
      ],
      "pathMembers": [
        null
      ],
      "sectionSortMethod": 0,
      "contentSortMethod": 0,
      "contentsAndSequences": {},
      "parentWorkflowID": 0,
      "inheritedPageLayouts": {},
      "currentOrInheritedWorkflow": 0,
      "contentNextSequence": 0,
      "accessControlOption": 0,
      "parentID": 0,
      "mirror": true,
      "allNames": {},
      "languageCount": 0,
      "mirrorSource": {},
      "link": true,
      "mirrorSourceID": 0
    }
  ],
  "lastModified": "string",
  "media": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
language string false none none
sections [Section] false none none

ContentMetaData

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "contentChannels": [
    {
      "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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    }
  ],
  "contentVersions": {
    "property1": {
      "id": 0,
      "language": "string",
      "version": "string",
      "status": 0
    },
    "property2": {
      "id": 0,
      "language": "string",
      "version": "string",
      "status": 0
    }
  },
  "cloneSource": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "contentChannels": [
      {}
    ],
    "contentVersions": {
      "property1": {},
      "property2": {}
    },
    "cloneSource": {
      "id": null,
      "contentTypeID": null,
      "archiveSection": null,
      "publishDate": null,
      "reviewDate": null,
      "expiryDate": null,
      "contentChannels": null,
      "contentVersions": null,
      "cloneSource": null,
      "sections": null,
      "channelIDs": null,
      "sectionIDs": null,
      "languages": null,
      "languageIndependant": null,
      "allLanguageMetaData": null,
      "languageCount": null
    },
    "sections": [
      {}
    ],
    "channelIDs": [
      0
    ],
    "sectionIDs": [
      0
    ],
    "languages": {},
    "languageIndependant": true,
    "allLanguageMetaData": {
      "property1": {},
      "property2": {}
    },
    "languageCount": 0
  },
  "sections": [
    {
      "section": {},
      "content": {},
      "printSequence": 0,
      "sortLock": "[",
      "sectionID": 0,
      "entityID": 0,
      "contentID": 0
    }
  ],
  "channelIDs": [
    0
  ],
  "sectionIDs": [
    0
  ],
  "languages": {},
  "languageIndependant": true,
  "allLanguageMetaData": {
    "property1": {
      "language": "string",
      "version": {},
      "name": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "owner": 0,
      "lastModifiedBy": 0,
      "previousVersion": {},
      "status": 0,
      "metaData": {},
      "draft": true,
      "approved": true,
      "ownerName": "string",
      "lastModifierName": "string"
    },
    "property2": {
      "language": "string",
      "version": {},
      "name": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "owner": 0,
      "lastModifiedBy": 0,
      "previousVersion": {},
      "status": 0,
      "metaData": {},
      "draft": true,
      "approved": true,
      "ownerName": "string",
      "lastModifierName": "string"
    }
  },
  "languageCount": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
contentTypeID integer(int32) false none none
archiveSection integer(int32) false none none
publishDate string(date-time) false none none
reviewDate string(date-time) false none none
expiryDate string(date-time) false none none
contentChannels [Channel] false none none
languageCount integer(int32) false none none

ContentMetaDataDTO

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "locked": true,
  "sectionIDs": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
contentTypeID integer(int32) false none none
archiveSection integer(int32) false none none
publishDate string(date-time) false none none
reviewDate string(date-time) false none none
expiryDate string(date-time) false none none
language string false none none
name string false none none
alternativeLanguages [ContentNameTranslationsDTO] false none none

ContentNameTranslationsDTO

{
  "language": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
language string false none none
name string false none none

ContentOwnerRow

{
  "content": {
    "id": 0,
    "text": "string",
    "language": "string"
  },
  "owner": {
    "id": 0,
    "text": "string",
    "username": "string",
    "name": "string"
  },
  "sections": [
    {
      "id": 0,
      "text": "string"
    }
  ],
  "lastModified": "2019-08-24T14:15:22Z",
  "status": 0
}

Properties

None

ContentPreviewDTO

{
  "id": 0,
  "name": "string",
  "contentTypeID": 0,
  "language": "string",
  "content": "string",
  "layout": "string",
  "version": "string",
  "status": 0,
  "sortOrder": 0,
  "directEditEnabled": true,
  "sortLock": "TOP",
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "future": true,
  "editable": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
contentTypeID integer(int32) false none none
language string false none none
content string false none none
layout string false none none
version string false none none
status integer(int32) false none none
sortOrder integer(int32) false none none
directEditEnabled boolean false none none
sortLock string false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

ContentSection

{
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "content": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "contentChannels": [
      {}
    ],
    "contentVersions": {
      "property1": {},
      "property2": {}
    },
    "cloneSource": {
      "id": null,
      "contentTypeID": null,
      "archiveSection": null,
      "publishDate": null,
      "reviewDate": null,
      "expiryDate": null,
      "contentChannels": null,
      "contentVersions": null,
      "cloneSource": null,
      "sections": null,
      "channelIDs": null,
      "sectionIDs": null,
      "languages": null,
      "languageIndependant": null,
      "allLanguageMetaData": null,
      "languageCount": null
    },
    "sections": [
      {}
    ],
    "channelIDs": [
      0
    ],
    "sectionIDs": [
      0
    ],
    "languages": {},
    "languageIndependant": true,
    "allLanguageMetaData": {
      "property1": {},
      "property2": {}
    },
    "languageCount": 0
  },
  "printSequence": 0,
  "sortLock": "TOP",
  "sectionID": 0,
  "entityID": 0,
  "contentID": 0
}

Properties

None

ContentType

{
  "id": 0,
  "name": "string",
  "description": "string",
  "warningMessage": "string",
  "elements": [
    {
      "name": "string",
      "description": "string",
      "typeID": 0,
      "type": {},
      "maxSize": 0,
      "compulsory": true,
      "sequence": 0,
      "alias": "string",
      "defaultValue": "string",
      "id": 0,
      "contentType": 0,
      "listId": 0
    }
  ],
  "elementForFilename": 0,
  "alias": "string",
  "directEditEnabled": true,
  "workflow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "contentTypes": [
      {}
    ],
    "section": [
      {}
    ],
    "workflowSteps": [
      {}
    ],
    "restricted": true,
    "firstStep": {
      "id": null,
      "name": null,
      "description": null,
      "lastModified": null,
      "priority": null,
      "restrictToEditors": null,
      "language": null,
      "users": null,
      "groups": null,
      "options": null,
      "workflowSteps": null
    }
  },
  "duplicate": true,
  "type": 0,
  "sectionID": 0,
  "minAuthLevel": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
warningMessage string false none none
elements [ContentTypeElement] false none none

ContentTypeDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": 0,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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": {},
      "binary": true
    }
  ],
  "metaMapped": true,
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "minAuthLevel": 0,
  "enableDirectEdit": true,
  "elementIdforFilename": 0,
  "warningMessage": "string",
  "sectionId": 0,
  "duplicate": true,
  "duplicatedFromId": 0,
  "fullyAccessible": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
type integer(int32) false none none
editable boolean false none none

ContentTypeElement

{
  "name": "string",
  "description": "string",
  "typeID": 0,
  "type": {
    "id": 0,
    "name": "string",
    "description": "string",
    "storageMethod": 0,
    "binary": true,
    "extensionChecking": true,
    "enabled": true
  },
  "maxSize": 0,
  "compulsory": true,
  "sequence": 0,
  "alias": "string",
  "defaultValue": "string",
  "id": 0,
  "contentType": 0,
  "listId": 0
}

Properties

Name Type Required Restrictions Description
name string false none none
description string false none none
typeID integer(int32) false none none

ContentTypeElementDTO

{
  "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
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
contentTypeID integer(int32) false none none
name string false none none
description string false none none
type integer(int32) false none none
maxSize integer(int32) false none none
compulsory boolean false none none
input_method integer(int32) false none none
listId integer(int32) false none none
sequence integer(int32) false none none
alias string false none none

ContentTypeMetaDataDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": 0,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "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": {},
      "binary": true
    }
  ],
  "metaMapped": true,
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "fullyAccessible": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
type integer(int32) false none none
editable boolean false none none

ContentTypeMetaInformationDTO

{
  "contentTypeID": 0,
  "elementID": 0,
  "metaIDs": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
contentTypeID integer(int32) false none none
elementID integer(int32) false none none
metaIDs [integer] false none none

ContentTypeReportMetaDataDTO

{
  "id": 0,
  "alias": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
alias string false none none

ContentTypeScope

{
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "warningMessage": "string",
    "elements": [
      {}
    ],
    "elementForFilename": 0,
    "alias": "string",
    "directEditEnabled": true,
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "duplicate": true,
    "type": 0,
    "sectionID": 0,
    "minAuthLevel": 0
  },
  "scope": 0,
  "contentTypeID": 0
}

Properties

None

ContentTypeScopeDTO

{
  "id": 0,
  "scope": 0,
  "inherited": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
scope integer(int32) false none none
inherited boolean false none none

ContentVersion

{
  "id": 0,
  "language": "string",
  "version": "string",
  "status": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
language string false none none
version string false none none
status integer(int32) false none none

DataObject

{
  "id": 0,
  "name": "string",
  "username": "string",
  "password": "string",
  "contentTypes": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
username string false none none
password string false none none
contentTypes string false none none

DataSource

{
  "id": 0,
  "name": "string",
  "username": "string",
  "password": "string",
  "url": "string",
  "driver": "string",
  "dataStores": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "databaseName": "string",
      "template": 0,
      "rootSection": 0,
      "archiveSection": 0,
      "contentStatus": 0,
      "tableName": "string",
      "query": "string",
      "channel": {},
      "language": {},
      "dataStoreMappings": [
        null
      ],
      "dataStoreContents": [
        null
      ],
      "dataSource": {},
      "siteStructure": {},
      "endPointProperties": "string",
      "individualSections": true,
      "individualEvents": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
username string false none none
password string false none none
url string false none none
driver string false none none
dataStores [DataStore] false none none

DataSourceDTO

{
  "id": 0,
  "name": "string",
  "username": "string",
  "password": "string",
  "url": "string",
  "driver": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
username string false none none
password string false none none
url string false none none
driver string false none none

DataSourceMetaData

{
  "dataSourceName": "string",
  "tablesMetaData": [
    {
      "name": "string",
      "required": true,
      "primaryKey": [
        null
      ],
      "columnCount": 0,
      "columns": [
        null
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
dataSourceName string false none none
tablesMetaData [Table] false none none

DataSourceTestResult

{
  "success": true,
  "message": "string"
}

Properties

Name Type Required Restrictions Description
success boolean false none none
message string false none none

DataStore

{
  "id": 0,
  "name": "string",
  "description": "string",
  "databaseName": "string",
  "template": 0,
  "rootSection": 0,
  "archiveSection": 0,
  "contentStatus": 0,
  "tableName": "string",
  "query": "string",
  "channel": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  },
  "language": {
    "code": "string",
    "name": "string",
    "charset": "string",
    "disclaimer": "string",
    "channels": [
      {}
    ]
  },
  "dataStoreMappings": [
    {
      "id": {},
      "columnName": "string",
      "link": "string"
    }
  ],
  "dataStoreContents": [
    {
      "id": {},
      "hash": "string",
      "linkValue": "string",
      "dataStore": {},
      "contentID": 0
    }
  ],
  "dataSource": {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "url": "string",
    "driver": "string",
    "dataStores": [
      {}
    ]
  },
  "siteStructure": {
    "id": 0,
    "name": "string",
    "plugin": "string"
  },
  "endPointProperties": "string",
  "individualSections": true,
  "individualEvents": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
databaseName string false none none
template integer(int32) false none none
rootSection integer(int32) true none none
archiveSection integer(int32) false none none
contentStatus integer(int32) false none none
tableName string false none none
query string false none none

DataStoreContent

{
  "id": {},
  "hash": "string",
  "linkValue": "string",
  "dataStore": {
    "id": 0,
    "name": "string",
    "description": "string",
    "databaseName": "string",
    "template": 0,
    "rootSection": 0,
    "archiveSection": 0,
    "contentStatus": 0,
    "tableName": "string",
    "query": "string",
    "channel": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "language": {
      "code": null,
      "name": null,
      "charset": null,
      "disclaimer": null,
      "channels": null
    },
    "dataStoreMappings": [
      {}
    ],
    "dataStoreContents": [
      {}
    ],
    "dataSource": {
      "id": null,
      "name": null,
      "username": null,
      "password": null,
      "url": null,
      "driver": null,
      "dataStores": null
    },
    "siteStructure": {
      "id": null,
      "name": null,
      "plugin": null
    },
    "endPointProperties": "string",
    "individualSections": true,
    "individualEvents": true
  },
  "contentID": 0
}

Properties

None

DataStoreContentPK

{}

Properties

None

DataStoreDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "template": 0,
  "rootSection": 0,
  "dataSourceID": 0,
  "siteStructureID": 0,
  "individualSections": true,
  "archiveSection": 0,
  "contentStatus": 0,
  "tableName": "string",
  "query": "string",
  "individualEvents": true,
  "channelID": 0,
  "languageCode": "string",
  "dataStoreMappings": [
    {
      "dataStoreID": 0,
      "elementName": "string",
      "columnName": "string",
      "link": "string"
    }
  ],
  "endPointProperties": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
template integer(int32) false none none
rootSection integer(int32) false none none
dataSourceID integer(int32) false none none
siteStructureID integer(int32) false none none
individualSections boolean false none none
archiveSection integer(int32) false none none
contentStatus integer(int32) false none none
tableName string false none none
query string false none none
individualEvents boolean false none none
channelID integer(int32) false none none
languageCode string false none none
dataStoreMappings [DataStoreMappingDTO] false none none

DataStoreMapping

{
  "id": {
    "dataStore": {
      "id": null,
      "name": null,
      "description": null,
      "databaseName": null,
      "template": null,
      "rootSection": null,
      "archiveSection": null,
      "contentStatus": null,
      "tableName": null,
      "query": null,
      "channel": null,
      "language": null,
      "dataStoreMappings": null,
      "dataStoreContents": null,
      "dataSource": null,
      "siteStructure": null,
      "endPointProperties": null,
      "individualSections": null,
      "individualEvents": null
    },
    "elementName": "string"
  },
  "columnName": "string",
  "link": "string"
}

Properties

None

DataStoreMappingDTO

{
  "dataStoreID": 0,
  "elementName": "string",
  "columnName": "string",
  "link": "string"
}

Properties

Name Type Required Restrictions Description
dataStoreID integer(int32) false none none
elementName string false none none
columnName string false none none
link string false none none

DataStoreMappingPK

{
  "dataStore": {
    "id": 0,
    "name": "string",
    "description": "string",
    "databaseName": "string",
    "template": 0,
    "rootSection": 0,
    "archiveSection": 0,
    "contentStatus": 0,
    "tableName": "string",
    "query": "string",
    "channel": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "language": {
      "code": null,
      "name": null,
      "charset": null,
      "disclaimer": null,
      "channels": null
    },
    "dataStoreMappings": [
      {}
    ],
    "dataStoreContents": [
      {}
    ],
    "dataSource": {
      "id": null,
      "name": null,
      "username": null,
      "password": null,
      "url": null,
      "driver": null,
      "dataStores": null
    },
    "siteStructure": {
      "id": null,
      "name": null,
      "plugin": null
    },
    "endPointProperties": "string",
    "individualSections": true,
    "individualEvents": true
  },
  "elementName": "string"
}

Properties

None

Database

{
  "name": "string",
  "version": "string",
  "address": "string",
  "connectedUser": "string",
  "sqlSupport": "string",
  "transactions": true
}

Properties

Name Type Required Restrictions Description
name string false none none
version string false none none
address string false none none
connectedUser string false none none
sqlSupport string false none none
transactions boolean false none none

DirectEditAnalyticsDTO

{
  "totalUnique": [
    {
      "date": "2019-08-24T14:15:22Z",
      "total": 0,
      "unique": 0,
      "dateString": "string"
    }
  ],
  "pageViewsThisMonth": 0,
  "bounceRateThisMonth": 0,
  "averageTimeThisMonth": 0,
  "mostVisitsFromCountryThisMonth": "string"
}

Properties

Name Type Required Restrictions Description
totalUnique [AnalyticsTotalUnique] false none none

DirectEditPagePreviewDTO

{
  "channel": 0,
  "id": 0,
  "language": "string",
  "header": "string",
  "content": [
    {
      "id": 0,
      "name": "string",
      "contentTypeID": 0,
      "language": "string",
      "content": "string",
      "layout": "string",
      "version": "string",
      "status": 0,
      "sortOrder": 0,
      "directEditEnabled": true,
      "sortLock": "[",
      "lock": {},
      "future": true,
      "editable": true
    }
  ],
  "footer": "string",
  "paths": [
    "string"
  ],
  "editable": true,
  "publishUrl": "string",
  "userScriptsAllowed": true
}

Properties

Name Type Required Restrictions Description
channel integer(int32) false none none
id integer(int32) false none none
language string false none none
header string false none none
content [ContentPreviewDTO] false none none

DirectEditPublishUrlAvailability

{
  "publishUrl": "string",
  "publishUrlExists": true
}

Properties

Name Type Required Restrictions Description
publishUrl string false none none
publishUrlExists boolean false none none

DuplicatedID

{
  "id": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none

Enumeration

{}

Properties

None

EnumerationString

{}

Properties

None

EventLogDto

{
  "key": 0,
  "eventLabel": "string",
  "primaryGroup": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
key integer(int32) false none none
eventLabel string false none none

ExtendedSectionData

{
  "id": 0,
  "type": 0,
  "enabled": true,
  "active": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
type integer(int32) false none none
enabled boolean false none none
active boolean false none none

ExtranetAccess

{
  "value": "string",
  "description": "string",
  "defaultAccessLevel": true
}

Properties

Name Type Required Restrictions Description
value string false none none
description string false none none
defaultAccessLevel boolean false none none

ExtranetConnectionParams

{
  "id": 0,
  "username": "string",
  "userType": 0,
  "emailAddress": "string",
  "firstName": "string",
  "lastName": "string",
  "licenseKeyHash": "string",
  "licenseOverContentLimit": "string",
  "localSmUrl": "string",
  "extranetAccess": "string",
  "mySupport": 0,
  "authToken": "string",
  "osArch": "string",
  "osName": "string",
  "osVersion": "string",
  "jvmVendor": "string",
  "jvmVersion": "string",
  "servletContainerName": "string",
  "servletSpecVersion": "string",
  "dbProductName": "string",
  "dbProductVersion": "string",
  "dbDriverName": "string",
  "dbDriverVersion": "string",
  "smVersion": "string",
  "documentCount": "string",
  "workflowCount": "string",
  "channelCount": "string",
  "templateCount": "string",
  "userCount": "string",
  "languageCount": "string",
  "language": "string",
  "hash": "string",
  "extranetConsent": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
username string false none none
userType integer(int32) false none none
emailAddress string false none none
firstName string false none none
lastName string false none none
licenseKeyHash string false none none
licenseOverContentLimit string false none none
localSmUrl string false none none
extranetAccess string false none none
mySupport integer(int32) false none none
authToken string false none none
osArch string false none none
osName string false none none
osVersion string false none none
jvmVendor string false none none
jvmVersion string false none none
servletContainerName string false none none
servletSpecVersion string false none none
dbProductName string false none none
dbProductVersion string false none none
dbDriverName string false none none
dbDriverVersion string false none none
smVersion string false none none
documentCount string false none none
workflowCount string false none none
channelCount string false none none
templateCount string false none none
userCount string false none none
languageCount string false none none
language string false none none
hash string false none none
extranetConsent boolean false none none

FileDownload

{
  "filename": "string",
  "file": "string",
  "mimeType": "string",
  "fileLocation": "string",
  "code": "string",
  "cleanUp": true,
  "contentID": 0,
  "language": "string",
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "element": "string"
}

Properties

Name Type Required Restrictions Description
filename string true none none
file string(binary) false none none
mimeType string true none none
fileLocation string true none none
code string false none none
cleanUp boolean false none none
contentID integer(int32) false none none
language string false none none

FileExtension

{
  "name": "string",
  "description": "string",
  "extension": "string",
  "channelFileExtensions": [
    {
      "id": {},
      "priority": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none none
description string true none none
extension string true none none
channelFileExtensions [ChannelFileExtension] false none none

FileUploadDTO

{
  "code": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
code string false none none
name string false none none

FormBuilderConfigurationResponse

{
  "formBuilderURI": "string",
  "connected": true,
  "licenseHash": "string",
  "publicKey": "string",
  "customerName": "string",
  "customerId": 0,
  "hostname": "string",
  "connectionStatus": "NOT_CONNECTED"
}

Properties

Name Type Required Restrictions Description
formBuilderURI string false none none
connected boolean false none none
licenseHash string false none none
publicKey string false none none
customerName string false none none
customerId integer(int32) false none none
hostname string false none none
connectionStatus string false none none

Enumerated Values

Property Value
connectionStatus NOT_CONNECTED
connectionStatus CONNECTED
connectionStatus CONNECTION_ERROR
connectionStatus VALIDATION_ERROR

FormContentType

{
  "id": 0,
  "name": "string",
  "alias": "string",
  "contentTypeElements": [
    {
      "id": 0,
      "name": "string",
      "alias": "string",
      "type": 0,
      "listId": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
alias string false none none
contentTypeElements [FormContentTypeElement] false none none

FormContentTypeElement

{
  "id": 0,
  "name": "string",
  "alias": "string",
  "type": 0,
  "listId": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
alias string false none none
type integer(int32) false none none
listId integer(int32) false none none

FormDefinition

{
  "id": 0,
  "name": "string",
  "description": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "showName": true,
  "showDescription": true,
  "includeCss": true,
  "usage": [
    {
      "formId": 0,
      "assetId": 0,
      "language": "string",
      "element": "string",
      "type": "string",
      "sectionId": 0,
      "name": "string"
    }
  ],
  "hasSubmissions": true,
  "embedUrl": "string",
  "shareUrl": "string",
  "formbankDomain": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
lastModified string(date-time) false none none
showName boolean false none none
showDescription boolean false none none
includeCss boolean false none none
usage [FormUsage] false none none

FormDefinitions

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "submissionSectionId": 0,
      "restricted": true,
      "incompleteMappings": true,
      "usage": [
        null
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
draw integer(int32) false none none
recordsTotal integer(int32) false none none
recordsFiltered integer(int32) false none none
data [FormRow] false none none

FormDependency

{
  "id": 0,
  "index": 0,
  "formId": 0,
  "parentId": 0,
  "actionFieldId": 0,
  "actionType": "string",
  "actionValue": 0,
  "logicalOperator": "string",
  "conditions": [
    {
      "id": 0,
      "formDependencyId": 0,
      "formFieldId": 0,
      "operator": "string",
      "value": "string",
      "logicalOperator": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
index integer(int32) false none none
formId integer(int32) false none none
parentId integer(int32) false none none
actionFieldId integer(int32) false none none
actionType string false none none
actionValue integer(int32) false none none
logicalOperator string false none none
conditions [FormDependencyCondition] false none none

FormDependencyCondition

{
  "id": 0,
  "formDependencyId": 0,
  "formFieldId": 0,
  "operator": "string",
  "value": "string",
  "logicalOperator": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
formDependencyId integer(int32) false none none
formFieldId integer(int32) false none none
operator string false none none
value string false none none
logicalOperator string false none none

FormList

{
  "id": 0,
  "name": "string",
  "description": "string",
  "language": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
language string false none none

FormListUsage

{
  "formId": 0,
  "elementLabel": "string"
}

Properties

Name Type Required Restrictions Description
formId integer(int32) false none none
elementLabel string false none none

FormMapping

{
  "id": 0,
  "formId": 0,
  "contentTypeId": 0,
  "formFieldId": 0,
  "elementName": "string",
  "contentElementID": 0,
  "strict": true,
  "alias": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
formId integer(int32) false none none
contentTypeId integer(int32) false none none
formFieldId integer(int32) false none none
elementName string false none none
contentElementID integer(int32) false none none
strict boolean false none none
alias string false none none

FormReportData

{
  "data": "string",
  "columnID": 0,
  "columnType": "string"
}

Properties

Name Type Required Restrictions Description
data string false none none
columnID integer(int32) false none none
columnType string false none none

FormRow

{
  "id": 0,
  "name": "string",
  "description": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "submissionSectionId": 0,
  "restricted": true,
  "incompleteMappings": true,
  "usage": [
    {
      "formId": 0,
      "assetId": 0,
      "language": "string",
      "element": "string",
      "type": "string",
      "sectionId": 0,
      "name": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
lastModified string(date-time) false none none
submissionSectionId integer(int32) false none none
restricted boolean false none none
incompleteMappings boolean false none none
usage [FormUsage] false none none

FormSubmissionReport

{
  "id": 0,
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "formName": "string",
  "sectionID": 0,
  "graphLabels": [
    "string"
  ],
  "graphData": [
    0
  ],
  "columns": [
    {
      "id": 0,
      "type": "string",
      "label": "string"
    }
  ],
  "formReportData": [
    [
      {
        "data": null,
        "columnID": null,
        "columnType": null
      }
    ]
  ],
  "data": [
    [
      "string"
    ]
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
draw integer(int32) false none none
recordsTotal integer(int32) false none none
recordsFiltered integer(int32) false none none
formName string false none none
sectionID integer(int32) false none none
graphLabels [string] false none none
graphData [integer] false none none
columns [FormSubmissionReportColumn] false none none

FormSubmissionReportColumn

{
  "id": 0,
  "type": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
type string false none none
label string false none none

FormUsage

{
  "formId": 0,
  "assetId": 0,
  "language": "string",
  "element": "string",
  "type": "string",
  "sectionId": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
formId integer(int32) false none none
assetId integer(int32) false none none
language string false none none
element string false none none
type string false none none
sectionId integer(int32) false none none
name string false none none

Group

{
  "id": 0,
  "name": "string",
  "description": "string",
  "emailAddress": "string",
  "createDate": "2019-08-24T14:15:22Z",
  "enabled": true,
  "ldap": true,
  "defaultChannel": 0,
  "children": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "children": [
        null
      ],
      "sections": [
        null
      ],
      "steps": [
        null
      ],
      "deleted": true,
      "memberCount": 0
    }
  ],
  "sections": [
    {
      "id": 0,
      "level": 0,
      "status": 0,
      "printSequence": 0,
      "formSection": true,
      "archived": true,
      "users": [
        null
      ],
      "viewUsers": [
        null
      ],
      "groups": [
        null
      ],
      "viewGroups": [
        null
      ],
      "contentSections": [
        null
      ],
      "sectionInfos": {},
      "mirrorSections": [
        null
      ],
      "links": {},
      "rootChannels": [
        null
      ],
      "appliedPageLayouts": [
        null
      ],
      "hierarchyMirrorAcOpt": {},
      "hierarchyMirrorMetadataOpt": {},
      "children": [
        null
      ],
      "contentTypeScopes": [
        null
      ],
      "cloneSource": {},
      "sectionPaths": {},
      "sortLock": "[",
      "parent": {},
      "mirrors": [
        null
      ],
      "root": true,
      "shown": true,
      "nextSequence": 0,
      "entityID": 0,
      "childOfMirrored": true,
      "metadataOption": 0,
      "workflowID": 0,
      "childOfMirror": true,
      "workflowName": "string",
      "workflow": {},
      "channelRoot": [
        null
      ],
      "languages": [
        null
      ],
      "channels": [
        null
      ],
      "pathMembers": [
        null
      ],
      "sectionSortMethod": 0,
      "contentSortMethod": 0,
      "contentsAndSequences": {},
      "parentWorkflowID": 0,
      "inheritedPageLayouts": {},
      "currentOrInheritedWorkflow": 0,
      "contentNextSequence": 0,
      "accessControlOption": 0,
      "parentID": 0,
      "mirror": true,
      "allNames": {},
      "languageCount": 0,
      "mirrorSource": {},
      "link": true,
      "mirrorSourceID": 0
    }
  ],
  "steps": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "priority": "[",
      "restrictToEditors": 0,
      "language": {},
      "users": [
        null
      ],
      "groups": [
        null
      ],
      "options": {},
      "workflowSteps": [
        null
      ]
    }
  ],
  "deleted": true,
  "memberCount": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
emailAddress string false none none
createDate string(date-time) false none none
enabled boolean false none none
ldap boolean false none none
defaultChannel integer(int32) false none none
children [Group] false none none

GroupDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "membersCount": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
membersCount integer(int32) false none none

GroupDto

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

GroupMetaData

{
  "id": 0,
  "name": "string",
  "description": "string",
  "emailAddress": "string",
  "createDate": "2019-08-24T14:15:22Z",
  "enabled": true,
  "ldap": true,
  "defaultChannel": 0,
  "deleted": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
emailAddress string false none none
createDate string(date-time) false none none
enabled boolean false none none
ldap boolean false none none
defaultChannel integer(int32) false none none
deleted boolean false none none

GroupMetaDataDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "membersCount": 0,
  "groupSections": [
    {
      "id": 0,
      "path": "string"
    }
  ],
  "members": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "defaultPreviewChannel": 0,
  "emailAddress": "string",
  "children": [
    0
  ],
  "groupChildren": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "ldap": true,
  "groupEnabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
membersCount integer(int32) false none none
groupSections [GroupSectionDTO] false none none

GroupSearchCredentialsDTO

{
  "groupsAllowed": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "defaultPreviewChannels": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ],
  "canDeleteGroupEnabled": true,
  "editSectionEnabled": true,
  "createNewGroupEnabled": true
}

Properties

Name Type Required Restrictions Description
groupsAllowed [GroupMetaDataDTO] false none none

GroupSectionDTO

{
  "id": 0,
  "path": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
path string false none none

HierarchyContentResponse

{
  "id": 0,
  "name": "string",
  "status": "string",
  "lastModified": "string",
  "lastModifiedBy": "string",
  "expired": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
status string false none none
lastModified string false none none
lastModifiedBy string false none none
expired boolean false none none

HierarchyContentResponseDTO

{
  "id": 0,
  "contents": [
    {
      "id": 0,
      "name": "string",
      "status": "string",
      "lastModified": "string",
      "lastModifiedBy": "string",
      "expired": true
    }
  ],
  "path": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
contents [HierarchyContentResponse] false none none

HierarchyMirrorACOpt

{
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "accessControlOption": 0,
  "id": 0
}

Properties

None

HierarchyMirrorMetadataOpt

{
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "metadataOption": 0,
  "id": 0
}

Properties

None

HierarchyResponse

{
  "id": 0,
  "names": {
    "property1": "string",
    "property2": "string"
  },
  "hasChildren": true,
  "open": true,
  "getcountContentApproved": 0,
  "getcountContentPending": 0,
  "getcountContentInactive": 0,
  "visible": true,
  "archive": true,
  "seoCheckingResult": 0,
  "accessibilityCheckingResult": 0,
  "status": 0,
  "icon": "string",
  "mirrorType": "string",
  "subsections": [
    {
      "id": 0,
      "names": {},
      "hasChildren": true,
      "open": true,
      "getcountContentApproved": 0,
      "getcountContentPending": 0,
      "getcountContentInactive": 0,
      "visible": true,
      "archive": true,
      "seoCheckingResult": 0,
      "accessibilityCheckingResult": 0,
      "status": 0,
      "icon": "string",
      "mirrorType": "string",
      "subsections": [
        null
      ],
      "link": true,
      "lastModified": "2019-08-24T14:15:22Z",
      "printSequence": 0,
      "language": "string",
      "showOptionsMenu": true,
      "path": "string",
      "enablePublish": true,
      "allowUserModifySections": true,
      "name": "string",
      "userAllowedModifySections": true,
      "publishEnabled": true
    }
  ],
  "link": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "language": "string",
  "showOptionsMenu": true,
  "path": "string",
  "enablePublish": true,
  "allowUserModifySections": true,
  "name": "string",
  "userAllowedModifySections": true,
  "publishEnabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
names object false none none
» additionalProperties string false none none
hasChildren boolean false none none
open boolean false none none
getcountContentApproved integer(int64) false none none
getcountContentPending integer(int64) false none none
getcountContentInactive integer(int64) false none none
visible boolean false none none
archive boolean false none none
seoCheckingResult integer(int32) false none none
accessibilityCheckingResult integer(int32) false none none
status integer(int32) false none none
icon string false none none
mirrorType string false none none
subsections [HierarchyResponse] false none none

HtmlEditorConfigurationOptionDTO

{
  "id": 0,
  "htmlEditorId": 0,
  "name": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
htmlEditorId integer(int32) false none none
name string false none none
value string false none none

HtmlEditorDTO

{
  "id": 0,
  "name": "string",
  "minimumAccessLevel": 0,
  "defaultEditor": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
minimumAccessLevel integer(int32) false none none
defaultEditor boolean false none none

HtmlEditorMetaDataDTO

{
  "id": 0,
  "name": "string",
  "minimumAccessLevel": 0,
  "classname": "string",
  "configurationOptions": [
    {
      "id": 0,
      "htmlEditorId": 0,
      "name": "string",
      "value": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
minimumAccessLevel integer(int32) false none none
classname string false none none
configurationOptions [HtmlEditorConfigurationOptionDTO] false none none

IDLanguageCompositeKey

{
  "id": 0,
  "language": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
language string false none none

IGroupedAssetSharingInformation

{
  "id": 0,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none

INetwork

{
  "networkName": "string",
  "defaultResource": "string",
  "callbackParams": {
    "property1": "string",
    "property2": "string"
  },
  "configName": "string",
  "networkCallbackParam": "string"
}

Properties

Name Type Required Restrictions Description
networkName string false none none
defaultResource string false none none
callbackParams object false none none
» additionalProperties string false none none
configName string false none none
networkCallbackParam string false none none

IStatus

{
  "key": "string",
  "moduleName": "string",
  "progress": 0,
  "totalOperations": 0,
  "taskName": "string",
  "cancelled": true,
  "percentage": 0,
  "task": "RESOLVE",
  "summary": "string"
}

Properties

Name Type Required Restrictions Description
key string false none none
moduleName string false none none
progress integer(int32) false none none
totalOperations integer(int32) false none none
taskName string false none none
cancelled boolean false none none
percentage integer(int32) false none none
task string false none none
summary string false none none

Enumerated Values

Property Value
task RESOLVE
task EXPORT_CONTENT
task IMPORT_ADD_CONTENT
task EXPORT_CONTENT_TYPE
task IMPORT_ADD_CONTENT_TYPE
task EXPORT_PAGELAYOUT
task EXPORT_NAVIGATION
task IMPORT_ADD_NAVIGATION
task EXPORT_PREDEFINED_LIST
task EXPORT_WORKFLOW
task EXPORT_MEDIA
task IMPORT_ADD_MEDIA
task IMPORT_ADD_FILE_EXTENSION
task EXPORT_SECTION
task EXPORT_CHANNEL
task IMPORT_ADD_CHANNEL
task IMPORT_ADD_PAGE_LAYOUT
task EXPORT_LANGUAGE
task EXPORT_CONTENT_TYPE_LAYOUT
task IMPORT_ADD_CONTENT_TYPE_LAYOUT
task IMPORT_ADD_SERVER_SIDE_LINK
task EXPORT_SERVER_SIDE_LINK
task EXPORT_MEDIA_CATEGORY
task IMPORT_ADD_MEDIA_TYPE
task IMPORT_ADD_MEDIA_CATEGORY
task IMPORT_ADD_LANGUAGE
task EXPORT_USER
task EXPORT_GROUP
task IMPORT_ADD_GROUP
task RESOLVE_CONTENT
task RESOLVE_CHANNEL
task RESOLVE_CONTENTTYPE
task RESOLVE_CONTENT_TYPE_LAYOUT
task RESOLVE_MEDIA
task RESOLVE_NAVIGATION
task RESOLVE_PAGE_LAYOUT
task RESOLVE_PREDEFINED_LIST
task IMPORT_ADD_PREDEFINED_LIST
task RESOLVE_SECTION
task IMPORT_ADD_SECTION
task RESOLVE_WORKFLOW
task RESOLVE_SERVER_SIDE_LINK
task RESOLVE_MEDIA_CATEGORY
task RESOLVE_MEDIA_VARIANT
task RESOLVE_USER
task RESOLVE_GROUP
task RESOLVE_LANGUAGE
task RESOLVE_MEDIA_TYPE
task EXPORT_MEDIA_TYPE
task EXPORT_FILE_EXTENSION
task ADD_USER_SELECTED_SEED
task WRITE_FILE
task EXPORT
task IMPORT
task DOWNLOAD
task RESOLVE_SECTION_PAGELAYOUT
task EXPORT_SECTION_PAGELAYOUT
task EXPORT_FILE

ImportDTO

{
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "name": "string"
}

Properties

Name Type Required Restrictions Description
configuration object false none none
» additionalProperties object false none none
name string false none none

InfoUtilsDatabaseObjectDTO

{
  "jdbc": {
    "driverName": "string",
    "driverVersion": "string",
    "datasourceClass": "string",
    "connectionClass": "string"
  },
  "database": {
    "name": "string",
    "version": "string",
    "address": "string",
    "connectedUser": "string",
    "sqlSupport": "string",
    "transactions": true
  },
  "queryFactories": [
    "string"
  ]
}

Properties

None

InfoUtilsEnvironmentVariablesObjectDTO

{
  "environmentalVariables": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name Type Required Restrictions Description
environmentalVariables object false none none
» additionalProperties string false none none

InfoUtilsLicenceCountObjectDTO

{
  "contentLimit": 0,
  "contentItemsInSystem": 0,
  "itemsCountedForLicence": 0,
  "remaining": 0
}

Properties

Name Type Required Restrictions Description
contentLimit integer(int32) false none none
contentItemsInSystem integer(int32) false none none
itemsCountedForLicence integer(int32) false none none
remaining integer(int32) false none none

InfoUtilsListenerObjectDTO

{
  "siteManagerListeners": [
    {
      "property1": "string",
      "property2": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
siteManagerListeners [object] false none none
» additionalProperties string false none none

InfoUtilsMetaDataDTO

{
  "os": {
    "arch": "string",
    "name": "string",
    "version": "string",
    "systemTime": "string",
    "defaultEncoding": "string",
    "localHostname": "string"
  },
  "t4": {
    "version": {
      "version": null,
      "subMinor": null,
      "major": null,
      "minor": null
    },
    "dbPatchLevel": 0
  }
}

Properties

None

InfoUtilsStatisticsObjectDTO

{
  "content": [
    {
      "property1": {},
      "property2": {}
    }
  ],
  "sections": {
    "property1": {},
    "property2": {}
  },
  "statistics": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name Type Required Restrictions Description
content [object] false none none
» additionalProperties object false none none
sections object false none none
» additionalProperties object false none none
statistics object false none none
» additionalProperties object false none none

InitialAPIKeyDTO

{
  "apiKeyMetadata": {
    "id": 0,
    "name": "string",
    "active": true,
    "deleted": true,
    "secret": [
      "string"
    ],
    "userId": 0,
    "lastModifiedBy": 0,
    "dateModified": "2019-08-24T14:15:22Z",
    "dateCreated": "2019-08-24T14:15:22Z",
    "invalidationDate": "2019-08-24T14:15:22Z",
    "expired": true
  },
  "apiKey": "string"
}

Properties

None

InputStream

{}

Properties

None

Iterator

{}

Properties

None

IteratorString

{}

Properties

None

Jdbc

{
  "driverName": "string",
  "driverVersion": "string",
  "datasourceClass": "string",
  "connectionClass": "string"
}

Properties

Name Type Required Restrictions Description
driverName string false none none
driverVersion string false none none
datasourceClass string false none none
connectionClass string false none none

Key

{
  "id": 0,
  "keyName": "string",
  "keyDescription": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "keys": "string",
  "privateKey": "string",
  "keyPassword": "string",
  "inUse": true,
  "usedFor": [
    "string"
  ],
  "itAPrivateKey": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
keyName string true none none
keyDescription string false none none
lastModified string(date-time) false none none
keys string false none none
privateKey string false none none
keyPassword string false none none
inUse boolean false none none
usedFor [string] false none none
itAPrivateKey boolean false none none

KeyMeta

{
  "id": 0,
  "keyName": "string",
  "keyDescription": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "keys": "string",
  "inUse": true,
  "usedFor": [
    "string"
  ],
  "itAPrivateKey": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
keyName string true none none
keyDescription string false none none
lastModified string(date-time) false none none
keys string false none none
inUse boolean false none none
usedFor [string] false none none
itAPrivateKey boolean false none none

KeyMetaDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

LDAPLoginContext

{
  "id": 0,
  "name": "string",
  "context": "string",
  "authLevel": 0,
  "defaultAuthMethod": 0,
  "group": 0,
  "filters": [
    {
      "id": 0,
      "contextID": 0,
      "attribute": "string",
      "value": "string",
      "exclude": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
name string true none none
context string true none none
authLevel integer(int32) false none none
defaultAuthMethod integer(int32) false none none
group integer(int32) false none none
filters [LDAPSearchFilter] false none none

LDAPSearchFilter

{
  "id": 0,
  "contextID": 0,
  "attribute": "string",
  "value": "string",
  "exclude": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
contextID integer(int32) true none none
attribute string false none none
value string true none none
exclude boolean false none none

Language

{
  "code": "string",
  "name": "string",
  "charset": "string",
  "disclaimer": "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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
code string true none none
name string true none none
charset string false none none
disclaimer string false none none
channels [Channel] false none none

LanguageDTO

{
  "code": "string",
  "name": "string",
  "charset": "string",
  "disclaimer": "string",
  "modified": true
}

Properties

Name Type Required Restrictions Description
code string false none none
name string false none none
charset string false none none
disclaimer string false none none
modified boolean false none none

LanguageMetaData

{
  "language": "string",
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "name": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "owner": 0,
  "lastModifiedBy": 0,
  "previousVersion": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "status": 0,
  "metaData": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "contentChannels": [
      {}
    ],
    "contentVersions": {
      "property1": {},
      "property2": {}
    },
    "cloneSource": {
      "id": null,
      "contentTypeID": null,
      "archiveSection": null,
      "publishDate": null,
      "reviewDate": null,
      "expiryDate": null,
      "contentChannels": null,
      "contentVersions": null,
      "cloneSource": null,
      "sections": null,
      "channelIDs": null,
      "sectionIDs": null,
      "languages": null,
      "languageIndependant": null,
      "allLanguageMetaData": null,
      "languageCount": null
    },
    "sections": [
      {}
    ],
    "channelIDs": [
      0
    ],
    "sectionIDs": [
      0
    ],
    "languages": {},
    "languageIndependant": true,
    "allLanguageMetaData": {
      "property1": {},
      "property2": {}
    },
    "languageCount": 0
  },
  "draft": true,
  "approved": true,
  "ownerName": "string",
  "lastModifierName": "string"
}

Properties

Name Type Required Restrictions Description
language string false none none

LanguageMetaDataDTO

{
  "language": "string",
  "version": "string",
  "name": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "lastModifierName": "string",
  "owner": 0,
  "lastModifiedBy": 0,
  "previousVersion": "string",
  "status": 0
}

Properties

Name Type Required Restrictions Description
language string false none none
version string false none none
name string false none none
lastModified string(date-time) false none none
lastModifierName string false none none
owner integer(int32) false none none
lastModifiedBy integer(int32) false none none
previousVersion string false none none
status integer(int32) false none none

LicenceContacts

{
  "salutation": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "legalSalutation": "string",
  "legalFirstname": "string",
  "legalLastname": "string"
}

Properties

Name Type Required Restrictions Description
salutation string false none none
firstname string false none none
lastname string false none none
email string false none none
legalSalutation string false none none
legalFirstname string false none none
legalLastname string false none none

LicenceDTO

{
  "id": 0,
  "name": "string",
  "modified": {
    "date": "string",
    "user": {
      "id": null,
      "username": null,
      "firstName": null,
      "lastName": null,
      "emailAddress": null,
      "defaultLang": null,
      "localeCountryCode": null,
      "localeLanguageCode": null,
      "localeVariant": null,
      "createDate": null,
      "lastLoginDate": null,
      "enabled": null,
      "password": null,
      "defaultPreviewChannel": null,
      "preferredHtmlEditor": null,
      "extranetConsent": null,
      "extranetAccess": null,
      "extranetConsentDatetime": null,
      "groups": null,
      "extensibleUserObjectContent": null,
      "sections": null,
      "userChannels": null,
      "locale": null,
      "fullName": null,
      "deleted": null,
      "powerUser": null,
      "administrator": null,
      "authLevel": null,
      "fullTinyMCELocaleCode": null,
      "appliedPreviewChannel": null,
      "propertyResourceBundle": null,
      "fullLocaleCode": null
    }
  },
  "order": 0,
  "valid": true,
  "key": "string",
  "validatedInfo": {
    "licencee": {
      "companyName": null,
      "registeredOffice": null,
      "territory": null,
      "companyStatus": null
    },
    "licenceContact": {
      "salutation": null,
      "firstname": null,
      "lastname": null,
      "email": null,
      "legalSalutation": null,
      "legalFirstname": null,
      "legalLastname": null
    },
    "partnerDetails": {
      "name": null,
      "partnerSalutation": null,
      "partnerFirstname": null,
      "partnerLastname": null
    },
    "licenceDetails": {
      "productLicenced": null,
      "begins": null,
      "ends": null,
      "hostname": null
    },
    "restrictions": {
      "content": null,
      "user": null,
      "channel": null,
      "workflow": null,
      "contentType": null,
      "language": null
    }
  }
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

LicenceDetails

{
  "productLicenced": "string",
  "begins": "2019-08-24T14:15:22Z",
  "ends": "2019-08-24T14:15:22Z",
  "hostname": "string"
}

Properties

Name Type Required Restrictions Description
productLicenced string false none none
begins string(date-time) false none none
ends string(date-time) false none none
hostname string false none none

LicenceMetaDataDTO

{
  "id": 0,
  "name": "string",
  "modified": {
    "date": "string",
    "user": {
      "id": null,
      "username": null,
      "firstName": null,
      "lastName": null,
      "emailAddress": null,
      "defaultLang": null,
      "localeCountryCode": null,
      "localeLanguageCode": null,
      "localeVariant": null,
      "createDate": null,
      "lastLoginDate": null,
      "enabled": null,
      "password": null,
      "defaultPreviewChannel": null,
      "preferredHtmlEditor": null,
      "extranetConsent": null,
      "extranetAccess": null,
      "extranetConsentDatetime": null,
      "groups": null,
      "extensibleUserObjectContent": null,
      "sections": null,
      "userChannels": null,
      "locale": null,
      "fullName": null,
      "deleted": null,
      "powerUser": null,
      "administrator": null,
      "authLevel": null,
      "fullTinyMCELocaleCode": null,
      "appliedPreviewChannel": null,
      "propertyResourceBundle": null,
      "fullLocaleCode": null
    }
  },
  "order": 0,
  "valid": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

Licencee

{
  "companyName": "string",
  "registeredOffice": "string",
  "territory": "string",
  "companyStatus": "string"
}

Properties

Name Type Required Restrictions Description
companyName string false none none
registeredOffice string false none none
territory string false none none
companyStatus string false none none 

{
  "sourceSection": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "language": "string",
  "url": "string",
  "section": 0,
  "target": "string",
  "inheritedAccessControl": 0,
  "overrideLink": true,
  "linkHasBeenOverridden": true,
  "type": 0,
  "sourceSectionID": 0,
  "persistentLanguage": "string"
}

Properties

None

LinkInfo

{
  "type": 0,
  "section": 0,
  "url": "string",
  "language": "string",
  "target": "string",
  "accessControl": 0,
  "override": true,
  "overridden": true
}

Properties

Name Type Required Restrictions Description
type integer(int32) false none none
section integer(int32) false none none
url string false none none
language string false none none
target string false none none
accessControl integer(int32) false none none
override boolean false none none
overridden boolean false none none

Locale

{
  "language": "string",
  "displayName": "string",
  "script": "string",
  "country": "string",
  "variant": "string",
  "extensionKeys": [
    "string"
  ],
  "unicodeLocaleAttributes": [
    "string"
  ],
  "unicodeLocaleKeys": [
    "string"
  ],
  "iso3Language": "string",
  "iso3Country": "string",
  "displayLanguage": "string",
  "displayScript": "string",
  "displayCountry": "string",
  "displayVariant": "string"
}

Properties

Name Type Required Restrictions Description
language string false none none
displayName string false none none
script string false none none
country string false none none
variant string false none none
extensionKeys [string] false none none
unicodeLocaleAttributes [string] false none none
unicodeLocaleKeys [string] false none none
iso3Language string false none none
iso3Country string false none none
displayLanguage string false none none
displayScript string false none none
displayCountry string false none none
displayVariant string false none none

LocaleMetaData

{
  "id": "string",
  "description": "string",
  "localeLanguageCode": "string",
  "localeCountryCode": "string",
  "localeVariant": "string",
  "defaultLocale": true
}

Properties

Name Type Required Restrictions Description
id string false none none
description string false none none
localeLanguageCode string false none none
localeCountryCode string false none none
localeVariant string false none none
defaultLocale boolean false none none

Manifest

{
  "referencedAssets": {
    "graph": {
      "vertices": null,
      "edges": null
    }
  },
  "languages": [
    "string"
  ],
  "name": "string",
  "report": {
    "reportType": "IMPORT",
    "entries": [
      {}
    ],
    "error": true,
    "importReportDirectory": "string",
    "packageName": "string",
    "errorReportEntry": {
      "asset": null,
      "action": null,
      "status": null,
      "date": null,
      "error": null,
      "packageName": null
    }
  },
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "error": true,
  "errorMessage": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  },
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0,
  "importMap": {
    "property1": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    },
    "property2": {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  },
  "orderedAssets": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ]
}

Properties

Name Type Required Restrictions Description
orderedAssets [PackageAsset] false none none

ManifestDTO

{
  "languages": [
    "string"
  ],
  "name": "string",
  "configuration": {
    "property1": {},
    "property2": {}
  },
  "createdDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "importGroup": 0,
  "primaryLanguage": "string",
  "seeds": [
    {
      "id": 0,
      "assetType": "[",
      "fromSection": 0,
      "languageCode": "string",
      "fromContentId": 0,
      "names": {},
      "systemAsset": true,
      "fileLocation": "string",
      "error": true,
      "fromContentTypeIds": [
        null
      ],
      "assetProperties": {}
    }
  ],
  "channelID": 0
}

Properties

Name Type Required Restrictions Description
languages [string] false none none
name string false none none
configuration object false none none
» additionalProperties object false none none
createdDate string(date-time) false none none
description string false none none
importGroup integer(int32) false none none
primaryLanguage string false none none
seeds [PackageAsset] false none none

Mapping

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

MappingPreviewDTO

{
  "url": "string",
  "mappingType": "XPATH",
  "mappingValue": "string",
  "defaultValue": "string",
  "dateFormat": "string",
  "content": 0,
  "id": 0,
  "parameters": {
    "property1": true,
    "property2": true
  },
  "html": "string",
  "list": true
}

Properties

Name Type Required Restrictions Description
url string false none none
mappingType string false none none
mappingValue string false none none
defaultValue string false none none
dateFormat string false none none
content integer(int32) false none none
id integer(int32) false none none
parameters object false none none
» additionalProperties boolean false none none
html string false none none
list boolean false none none

Enumerated Values

Property Value
mappingType XPATH
mappingType SELECTOR
mappingType NO_MAPPING
mappingType ENTIRE_PAGE

MassApproveDto

{
  "comment": "string",
  "fastTrack": "string",
  "ids": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
comment string false none none
fastTrack string false none none
ids [integer] false none none

MediaCategoryDTO

{
  "id": 0,
  "language": "string",
  "name": "string",
  "accessLevel": 0,
  "status": 0,
  "children": [
    {
      "id": 0,
      "language": "string",
      "name": "string",
      "accessLevel": 0,
      "status": 0,
      "children": [
        null
      ],
      "lastModified": "2019-08-24T14:15:22Z",
      "printSequence": 0,
      "open": true
    }
  ],
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "open": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
language string false none none
name string false none none
accessLevel integer(int32) false none none
status integer(int32) false none none
children [MediaCategoryDTO] false none none

MediaCategoryPublishRuleDTO

{
  "channelID": 0,
  "mediaTypeID": 0,
  "publishRuleID": 0,
  "categoryID": 0
}

Properties

Name Type Required Restrictions Description
channelID integer(int32) false none none
mediaTypeID integer(int32) false none none
publishRuleID integer(int32) false none none
categoryID integer(int32) false none none

MediaCategorySectionDTO

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "accessLevel": 0,
  "categoryReadRestricted": true,
  "mediaCategoryPublishRuleDTOs": [
    {
      "channelID": 0,
      "mediaTypeID": 0,
      "publishRuleID": 0,
      "categoryID": 0
    }
  ],
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
parent integer(int32) false none none
name string false none none
description string false none none
outputUrl string false none none
outputFilename string false none none
accessKey string false none none
keyPhrase string false none none
status integer(int32) false none none
workflow integer(int32) false none none
parentWorkflowName string false none none
show boolean false none none
iseForm boolean false none none
archive boolean false none none
lastModified string(date-time) false none none
printSequence integer(int32) false none none
contentSortMethod integer(int32) false none none
sectionSortMethod integer(int32) false none none
path string false none none
mirrorOf integer(int32) false none none
sourceOfMirror boolean false none none
link boolean false none none
channels [AppliedPageLayoutsDTO] false none none

MediaDTO

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-08-24T14:15:22Z",
  "reviewDate": "2019-08-24T14:15:22Z",
  "expiryDate": "2019-08-24T14:15:22Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-08-24T14:15:22Z",
  "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-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "contentTypeAccess": 0,
  "contentTypeLock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "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
  ],
  "syntax": 0,
  "type": 0,
  "binaryLanguage": "string",
  "categories": [
    0
  ],
  "versions": [
    {
      "owner": "string",
      "lastModified": "string",
      "lastModifiedBy": "string",
      "name": "string",
      "version": "string",
      "previousVersion": "string"
    }
  ],
  "keywords": "string",
  "description": "string",
  "typeName": "string",
  "mediaURL": "string",
  "thumbnailURL": "string",
  "mediaPath": "string",
  "mediaSize": 0,
  "fileName": "string",
  "text": "string",
  "variant": 0,
  "variantsAllowed": true,
  "variantName": "string",
  "variantDimensions": "string",
  "accessLevel": 0,
  "locked": true,
  "sectionIDs": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
contentTypeID integer(int32) false none none
archiveSection integer(int32) false none none
publishDate string(date-time) false none none
reviewDate string(date-time) false none none
expiryDate string(date-time) false none none
language string false none none
name string false none none
alternativeLanguages [ContentNameTranslationsDTO] false none none

MediaFormat

{
  "mediaTypeID": 0,
  "mediaLayout": "string",
  "default": true
}

Properties

Name Type Required Restrictions Description
mediaTypeID integer(int32) true none none
mediaLayout string true none none
default boolean false none none

MediaFormatDTO

{
  "mediaTypeID": 0,
  "mediaLayout": "string",
  "defaultMediaFormat": true
}

Properties

Name Type Required Restrictions Description
mediaTypeID integer(int32) false none none
mediaLayout string false none none
defaultMediaFormat boolean false none none

MediaItemTableData

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "accessLevel": 0,
  "mediaRows": [
    {
      "id": 0,
      "status": 0,
      "language": "string",
      "name": "string",
      "description": "string",
      "version": "string",
      "fileName": "string",
      "fileSize": 0,
      "mediaTypeName": "string",
      "thumbnailURL": "string",
      "binaryLanguage": "string",
      "lock": {},
      "numberOfVariants": 0,
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
draw integer(int32) false none none
recordsTotal integer(int32) false none none
recordsFiltered integer(int32) false none none
accessLevel integer(int32) false none none
mediaRows [MediaRow] false none none

MediaMetaDataDTO

{
  "syntax": 0,
  "name": "string",
  "description": "string",
  "fileName": "string",
  "mediaSize": "string",
  "language": "string",
  "binaryLanguage": "string",
  "version": "string",
  "status": 0,
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "typeName": "string",
  "type": 0,
  "id": 0,
  "thumbnail": "string"
}

Properties

Name Type Required Restrictions Description
syntax integer(int32) false none none
name string false none none
description string false none none
fileName string false none none
mediaSize string false none none
language string false none none
binaryLanguage string false none none
version string false none none
status integer(int32) false none none

MediaRow

{
  "id": 0,
  "status": 0,
  "language": "string",
  "name": "string",
  "description": "string",
  "version": "string",
  "fileName": "string",
  "fileSize": 0,
  "mediaTypeName": "string",
  "thumbnailURL": "string",
  "binaryLanguage": "string",
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "numberOfVariants": 0,
  "lastModified": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
status integer(int32) false none none
language string false none none
name string false none none
description string false none none
version string false none none
fileName string false none none
fileSize integer(int64) false none none
mediaTypeName string false none none
thumbnailURL string false none none
binaryLanguage string false none none

MediaType

{
  "id": 0,
  "name": "string",
  "permittedExtensions": "string",
  "maxSize": 0,
  "formats": [
    {
      "mediaTypeID": 0,
      "mediaLayout": "string",
      "default": true
    }
  ],
  "defaultFormat": {
    "mediaTypeID": 0,
    "mediaLayout": "string",
    "default": true
  },
  "allFormats": [
    {
      "mediaTypeID": 0,
      "mediaLayout": "string",
      "default": true
    }
  ],
  "parseForTagsEnabled": true,
  "permittedExtensionsFormatted": [
    "string"
  ],
  "binary": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
permittedExtensions string false none none
maxSize integer(int32) false none none
formats [MediaFormat] false none none

MediaTypeDTO

{
  "id": 0,
  "name": "string",
  "permittedExtensions": "string",
  "maxSize": 0,
  "formatters": [
    {
      "mediaTypeID": 0,
      "mediaLayout": "string",
      "defaultMediaFormat": true
    }
  ],
  "binaryEnabled": true,
  "parseForTagsEnabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
permittedExtensions string false none none
maxSize integer(int32) false none none
formatters [MediaFormatDTO] false none none

MediaTypePublishRule

{
  "id": {
    "channel": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "mediaTypeID": 0
  },
  "publishRule": 0
}

Properties

None

MediaTypePublishRuleDTO

{
  "channelID": 0,
  "publishRule": 0,
  "mediaTypeID": 0
}

Properties

Name Type Required Restrictions Description
channelID integer(int32) false none none
publishRule integer(int32) false none none
mediaTypeID integer(int32) false none none

MediaTypePublishRulePK

{
  "channel": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  },
  "mediaTypeID": 0
}

Properties

None

MediaUsageDTO

{
  "contentName": "string",
  "assetType": "string",
  "variant": "string",
  "location": "string",
  "occurrences": 0,
  "language": "string",
  "contentID": 0,
  "sectionID": 0,
  "hasAccess": true,
  "contentLayoutContentTypeID": 0,
  "mediaID": 0,
  "variantUsage": true
}

Properties

Name Type Required Restrictions Description
contentName string false none none
assetType string false none none
variant string false none none
location string false none none
occurrences integer(int32) false none none
language string false none none
contentID integer(int32) false none none
sectionID integer(int32) false none none
hasAccess boolean false none none
contentLayoutContentTypeID integer(int32) false none none
mediaID integer(int32) false none none
variantUsage boolean false none none

MediaVariantDTO

{
  "name": "string",
  "width": 0,
  "height": 0,
  "retainAspectRatio": true,
  "newName": "string",
  "modified": true
}

Properties

Name Type Required Restrictions Description
name string false none none
width integer(int32) false none none
height integer(int32) false none none
retainAspectRatio boolean false none none
newName string false none none
modified boolean false none none

MediaVersionDTO

{
  "owner": "string",
  "lastModified": "string",
  "lastModifiedBy": "string",
  "name": "string",
  "version": "string",
  "previousVersion": "string"
}

Properties

Name Type Required Restrictions Description
owner string false none none
lastModified string false none none
lastModifiedBy string false none none
name string false none none
version string false none none
previousVersion string false none none

MediumDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "path": "string",
  "enabled": true,
  "type": 0,
  "className": "string",
  "username": "string",
  "password": "string",
  "tlsEncryptionType": "string",
  "tlsPort": "string",
  "serverType": 0,
  "secondary": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
path string false none none
enabled boolean false none none
type integer(int32) false none none
className string false none none
username string false none none
password string false none none
tlsEncryptionType string false none none
tlsPort string false none none
serverType integer(int32) false none none
secondary integer(int32) false none none

MenuDTO

{
  "id": 0,
  "ordinal": 0,
  "title": "string",
  "icon": "string",
  "href": "string",
  "subMenus": [
    {
      "id": 0,
      "ordinal": 0,
      "title": "string",
      "icon": "string",
      "href": "string",
      "subMenus": [
        null
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
ordinal integer(int32) false none none
title string false none none
icon string false none none
href string false none none
subMenus [MenuDTO] false none none

MetaDataDTO

{
  "id": 0,
  "value": "string",
  "lang": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
value string false none none
lang string false none none

MetaDataValue

{
  "sectionInfo": {
    "section": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "language": "string",
    "name": "string",
    "lastModified": "2019-08-24T14:15:22Z",
    "outputUri": "string",
    "outputFilename": "string",
    "keyPhrase": "string",
    "accessKey": "string",
    "contentOwner": 0,
    "metaDatas": [
      {}
    ]
  },
  "metaTag": {
    "id": 0,
    "name": "string",
    "specialMappings": {
      "id": null,
      "value": null,
      "format": null,
      "metaTag": null
    },
    "hierarchyMetaTags": [
      {}
    ],
    "metaAttribute": 0,
    "persistentLanguageOptions": {
      "override": null,
      "type": null,
      "default": null,
      "id": null,
      "persistentLanguage": null
    },
    "language": "string",
    "value": "string",
    "format": "string"
  },
  "value": "string",
  "language": "string",
  "sectionID": 0,
  "metaTagName": "string",
  "metaTagID": 0
}

Properties

None

MetaTag

{
  "id": 0,
  "name": "string",
  "specialMappings": {
    "id": 0,
    "value": "string",
    "format": "string",
    "metaTag": {
      "id": null,
      "name": null,
      "specialMappings": null,
      "hierarchyMetaTags": null,
      "metaAttribute": null,
      "persistentLanguageOptions": null,
      "language": null,
      "value": null,
      "format": null
    }
  },
  "hierarchyMetaTags": [
    {
      "sectionInfo": {},
      "metaTag": {},
      "value": "string",
      "language": "string",
      "sectionID": 0,
      "metaTagName": "string",
      "metaTagID": 0
    }
  ],
  "metaAttribute": 0,
  "persistentLanguageOptions": {
    "override": true,
    "type": 0,
    "default": true,
    "id": 0,
    "persistentLanguage": "string"
  },
  "language": "string",
  "value": "string",
  "format": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

MetaTagDTO

{
  "id": 0,
  "name": "string",
  "setting": 0,
  "language": "string",
  "format": "string",
  "specialMapping": 0,
  "metaAttribute": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
setting integer(int32) false none none
language string false none none
format string false none none
specialMapping integer(int32) false none none
metaAttribute integer(int32) false none none

MetaTagSpecialMappings

{
  "id": 0,
  "value": "string",
  "format": "string",
  "metaTag": {
    "id": 0,
    "name": "string",
    "specialMappings": {
      "id": null,
      "value": null,
      "format": null,
      "metaTag": null
    },
    "hierarchyMetaTags": [
      {}
    ],
    "metaAttribute": 0,
    "persistentLanguageOptions": {
      "override": null,
      "type": null,
      "default": null,
      "id": null,
      "persistentLanguage": null
    },
    "language": "string",
    "value": "string",
    "format": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
value string false none none
format string false none none

MicroSite

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

Modified

{
  "date": "string",
  "user": {
    "id": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string",
    "defaultLang": "string",
    "localeCountryCode": "string",
    "localeLanguageCode": "string",
    "localeVariant": "string",
    "createDate": "2019-08-24T14:15:22Z",
    "lastLoginDate": "2019-08-24T14:15:22Z",
    "enabled": true,
    "password": {
      "salt": null,
      "hashedPassword": null,
      "hashIterations": null
    },
    "defaultPreviewChannel": 0,
    "preferredHtmlEditor": 0,
    "extranetConsent": true,
    "extranetAccess": "string",
    "extranetConsentDatetime": "2019-08-24T14:15:22Z",
    "groups": [
      {}
    ],
    "extensibleUserObjectContent": {
      "metaData": null,
      "elements": null,
      "language": null,
      "name": null,
      "owner": null,
      "id": null,
      "version": null,
      "lastModified": null,
      "status": null,
      "sections": null,
      "channelIDs": null,
      "contentTypeID": null,
      "expiryDate": null,
      "sectionIDs": null,
      "archiveSection": null,
      "reviewDate": null,
      "publishDate": null,
      "elementCount": null,
      "lastModifiedBy": null,
      "previousVersion": null
    },
    "sections": [
      {}
    ],
    "userChannels": [
      {}
    ],
    "locale": {
      "language": null,
      "displayName": null,
      "script": null,
      "country": null,
      "variant": null,
      "extensionKeys": null,
      "unicodeLocaleAttributes": null,
      "unicodeLocaleKeys": null,
      "iso3Language": null,
      "iso3Country": null,
      "displayLanguage": null,
      "displayScript": null,
      "displayCountry": null,
      "displayVariant": null
    },
    "fullName": "string",
    "deleted": true,
    "powerUser": true,
    "administrator": true,
    "authLevel": 0,
    "fullTinyMCELocaleCode": "string",
    "appliedPreviewChannel": 0,
    "propertyResourceBundle": {
      "locale": null,
      "keys": null,
      "baseBundleName": null
    },
    "fullLocaleCode": "string"
  }
}

Properties

Name Type Required Restrictions Description
date string false none none

Module

{
  "layer": {},
  "name": "string",
  "descriptor": {
    "open": true,
    "automatic": true
  },
  "classLoader": {
    "parent": {
      "parent": null,
      "name": null,
      "unnamedModule": null,
      "registeredAsParallelCapable": null,
      "definedPackages": null
    },
    "name": "string",
    "unnamedModule": {
      "layer": null,
      "name": null,
      "descriptor": null,
      "classLoader": null,
      "annotations": null,
      "declaredAnnotations": null,
      "named": null,
      "packages": null
    },
    "registeredAsParallelCapable": true,
    "definedPackages": [
      {}
    ]
  },
  "annotations": [
    {}
  ],
  "declaredAnnotations": [
    {}
  ],
  "named": true,
  "packages": [
    "string"
  ]
}

Properties

None

ModuleDescriptor

{
  "open": true,
  "automatic": true
}

Properties

Name Type Required Restrictions Description
open boolean false none none
automatic boolean false none none

ModuleLayer

{}

Properties

None

Navigation

{
  "id": 0,
  "name": "string",
  "description": "string",
  "enabled": true,
  "navigationType": "string",
  "properties": {
    "property1": {},
    "property2": {}
  },
  "frontEndFileName": "string",
  "navigationProperties": {
    "property1": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    },
    "property2": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    }
  },
  "xhtmloutput": true,
  "typeKeyword": "string",
  "createdDate": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
enabled boolean false none none
navigationType string false none none
properties object false none none
» additionalProperties object false none none
frontEndFileName string false none none
navigationProperties object false none none
xhtmloutput boolean false none none
typeKeyword string false none none
createdDate string(date-time) false none none

NavigationDTO

{
  "id": 0,
  "name": "string",
  "navigationType": "string",
  "navigationKey": "string",
  "frontEndFileName": "string",
  "description": "string",
  "date": "string",
  "sharedGroupCount": 0,
  "editable": true,
  "enabled": true,
  "previewMode": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "properties": {
    "property1": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    },
    "property2": {
      "value": "string",
      "attribute": "string",
      "navigationPropertyID": 0,
      "navigation": {}
    }
  },
  "fullyAccessible": true,
  "xhtmlcompliant": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
navigationType string false none none
navigationKey string false none none
frontEndFileName string false none none
description string false none none
date string false none none
sharedGroupCount integer(int32) false none none
editable boolean false none none
enabled boolean false none none
previewMode boolean false none none
fullyAccessible boolean false none none
xhtmlcompliant boolean false none none

NavigationMetaDataDTO

{
  "id": 0,
  "sharedGroupCount": 0,
  "name": "string",
  "description": "string",
  "navigationType": "string",
  "navigationTypeName": "string",
  "editable": true,
  "enable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "deprecated": true,
  "deprecationCode": "string",
  "fullyAccessible": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
sharedGroupCount integer(int32) false none none
name string false none none
description string false none none
navigationType string false none none
navigationTypeName string false none none
editable boolean false none none
enable boolean false none none

NavigationProperty

{
  "value": "string",
  "attribute": "string",
  "navigationPropertyID": 0,
  "navigation": {
    "id": 0,
    "name": "string",
    "description": "string",
    "enabled": true,
    "navigationType": "string",
    "properties": {
      "property1": {},
      "property2": {}
    },
    "frontEndFileName": "string",
    "navigationProperties": {
      "property1": {},
      "property2": {}
    },
    "xhtmloutput": true,
    "typeKeyword": "string",
    "createdDate": "2019-08-24T14:15:22Z"
  }
}

Properties

Name Type Required Restrictions Description
value string false none none
attribute string false none none
navigationPropertyID integer(int32) false none none

NavigationTypeDTO

{
  "name": "string",
  "description": "string",
  "key": "string",
  "type": "string",
  "supportsCaching": true,
  "frontEndFileName": "string"
}

Properties

Name Type Required Restrictions Description
name string false none none
description string false none none
key string false none none
type string false none none
supportsCaching boolean false none none
frontEndFileName string false none none

NewContentDTO

{
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": null,
      "group": null,
      "assetID": null,
      "groupID": null,
      "assetType": null,
      "readLevel": null,
      "groupName": null
    },
    "sharedGroups": [
      {}
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {}
    ],
    "metaMapped": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "minAuthLevel": 0,
    "enableDirectEdit": true,
    "elementIdforFilename": 0,
    "warningMessage": "string",
    "sectionId": 0,
    "duplicate": true,
    "duplicatedFromId": 0,
    "fullyAccessible": true
  },
  "channels": [
    0
  ],
  "types": [
    {
      "id": 0,
      "name": "string",
      "listType": true
    }
  ],
  "canPublishNow": true,
  "canSaveAndApprove": true
}

Properties

None

Notification

{
  "id": 0,
  "notificationType": "PUBLISH",
  "notificationStatus": "IN_PROGRESS",
  "createdTime": "2019-08-24T14:15:22Z",
  "executionTime": "2019-08-24T14:15:22Z",
  "completionTime": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": "string",
    "property2": "string"
  },
  "userNotificationMappings": [
    {
      "notification": {},
      "user": {}
    }
  ],
  "users": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "notificationProperties": {
    "property1": {
      "id": 0,
      "propertyKey": "string",
      "propertyValue": "string"
    },
    "property2": {
      "id": 0,
      "propertyKey": "string",
      "propertyValue": "string"
    }
  },
  "notificationScheduled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
notificationType string false none none
notificationStatus string false none none
createdTime string(date-time) false none none
executionTime string(date-time) false none none
completionTime string(date-time) false none none
properties object false none none
» additionalProperties string false none none
userNotificationMappings [NotificationUserMapping] false none none
notificationScheduled boolean false none none

Enumerated Values

Property Value
notificationType PUBLISH
notificationType TRANSFER
notificationType CONTENTSYNC
notificationType ACCESSIBILITY
notificationType MEMORYUSAGE
notificationType LDAPIMPORT
notificationType SUBMISSIONIMPORT
notificationType CONTENTTYPEUPDATE
notificationType FORMBUILDERCONNECTION
notificationType OTHER
notificationStatus IN_PROGRESS
notificationStatus QUEUED
notificationStatus COMPLETE
notificationStatus FAILED

NotificationProperty

{
  "id": 0,
  "propertyKey": "string",
  "propertyValue": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
propertyKey string false none none
propertyValue string false none none

NotificationUserMapping

{
  "notification": {
    "id": 0,
    "notificationType": "PUBLISH",
    "notificationStatus": "IN_PROGRESS",
    "createdTime": "2019-08-24T14:15:22Z",
    "executionTime": "2019-08-24T14:15:22Z",
    "completionTime": "2019-08-24T14:15:22Z",
    "properties": {
      "property1": "string",
      "property2": "string"
    },
    "userNotificationMappings": [
      {}
    ],
    "users": [
      {}
    ],
    "notificationProperties": {
      "property1": {},
      "property2": {}
    },
    "notificationScheduled": true
  },
  "user": {
    "id": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string",
    "defaultLang": "string",
    "localeCountryCode": "string",
    "localeLanguageCode": "string",
    "localeVariant": "string",
    "createDate": "2019-08-24T14:15:22Z",
    "lastLoginDate": "2019-08-24T14:15:22Z",
    "enabled": true,
    "password": {
      "salt": null,
      "hashedPassword": null,
      "hashIterations": null
    },
    "defaultPreviewChannel": 0,
    "preferredHtmlEditor": 0,
    "extranetConsent": true,
    "extranetAccess": "string",
    "extranetConsentDatetime": "2019-08-24T14:15:22Z",
    "groups": [
      {}
    ],
    "extensibleUserObjectContent": {
      "metaData": null,
      "elements": null,
      "language": null,
      "name": null,
      "owner": null,
      "id": null,
      "version": null,
      "lastModified": null,
      "status": null,
      "sections": null,
      "channelIDs": null,
      "contentTypeID": null,
      "expiryDate": null,
      "sectionIDs": null,
      "archiveSection": null,
      "reviewDate": null,
      "publishDate": null,
      "elementCount": null,
      "lastModifiedBy": null,
      "previousVersion": null
    },
    "sections": [
      {}
    ],
    "userChannels": [
      {}
    ],
    "locale": {
      "language": null,
      "displayName": null,
      "script": null,
      "country": null,
      "variant": null,
      "extensionKeys": null,
      "unicodeLocaleAttributes": null,
      "unicodeLocaleKeys": null,
      "iso3Language": null,
      "iso3Country": null,
      "displayLanguage": null,
      "displayScript": null,
      "displayCountry": null,
      "displayVariant": null
    },
    "fullName": "string",
    "deleted": true,
    "powerUser": true,
    "administrator": true,
    "authLevel": 0,
    "fullTinyMCELocaleCode": "string",
    "appliedPreviewChannel": 0,
    "propertyResourceBundle": {
      "locale": null,
      "keys": null,
      "baseBundleName": null
    },
    "fullLocaleCode": "string"
  }
}

Properties

None

OS

{
  "arch": "string",
  "name": "string",
  "version": "string",
  "systemTime": "string",
  "defaultEncoding": "string",
  "localHostname": "string"
}

Properties

Name Type Required Restrictions Description
arch string false none none
name string false none none
version string false none none
systemTime string false none none
defaultEncoding string false none none
localHostname string false none none

OutputStream

{}

Properties

None

OwnerCell

{
  "id": 0,
  "text": "string",
  "username": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
text string false none none
username string false none none
name string false none none

OwnerDTO

{
  "id": 0,
  "type": "USER"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
type string false none none

Enumerated Values

Property Value
type USER
type GROUP

Package

{
  "name": "string",
  "annotations": [
    {}
  ],
  "declaredAnnotations": [
    {}
  ],
  "sealed": true,
  "specificationTitle": "string",
  "specificationVersion": "string",
  "specificationVendor": "string",
  "implementationTitle": "string",
  "implementationVersion": "string",
  "implementationVendor": "string"
}

Properties

Name Type Required Restrictions Description
name string false none none
annotations [Annotation] false none none

PackageAsset

{
  "id": 0,
  "assetType": "CONTENT",
  "fromSection": 0,
  "languageCode": "string",
  "fromContentId": 0,
  "names": {
    "property1": "string",
    "property2": "string"
  },
  "systemAsset": true,
  "fileLocation": "string",
  "error": true,
  "fromContentTypeIds": [
    0
  ],
  "assetProperties": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
assetType string false none none
fromSection integer(int32) false none none
languageCode string false none none
fromContentId integer(int32) false none none
names object false none none
» additionalProperties string false none none
systemAsset boolean false none none
fileLocation string false none none
error boolean false none none
fromContentTypeIds [integer] false none none
assetProperties object false none none
» additionalProperties object false none none

Enumerated Values

Property Value
assetType CONTENT
assetType CONTENT_TYPE
assetType PAGE_LAYOUT
assetType NAVIGATION_OBJECT
assetType PREDEFINED_LIST
assetType WORKFLOW
assetType MEDIA
assetType SECTION
assetType CHANNEL
assetType LANGUAGE
assetType CONTENT_TYPE_LAYOUT
assetType SERVER_SIDE_LINK
assetType MEDIA_CATEGORY
assetType GROUP
assetType USER
assetType GROUP_ASSET
assetType MEDIA_TYPE
assetType FILE_EXTENSION
assetType FILE

PackageEdge

{
  "origin": {
    "edges": [
      {}
    ],
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    }
  },
  "relationship": "CHANNEL_PAGE_LAYOUT",
  "destination": {
    "edges": [
      {}
    ],
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    }
  }
}

Properties

None

PackageGraph

{
  "vertices": [
    {
      "edges": [
        null
      ],
      "asset": {}
    }
  ],
  "edges": [
    {
      "origin": {},
      "relationship": "[",
      "destination": {}
    }
  ]
}

Properties

Name Type Required Restrictions Description
vertices [PackageVertex] false none none

PackageMetaDTO

{
  "name": "string",
  "description": "string",
  "createdDate": "string",
  "status": true,
  "error": true,
  "type": "string"
}

Properties

Name Type Required Restrictions Description
name string false none none
description string false none none
createdDate string false none none
status boolean false none none
error boolean false none none
type string false none none

PackageVertex

{
  "edges": [
    {
      "origin": {},
      "relationship": "[",
      "destination": {}
    }
  ],
  "asset": {
    "id": 0,
    "assetType": "CONTENT",
    "fromSection": 0,
    "languageCode": "string",
    "fromContentId": 0,
    "names": {
      "property1": "string",
      "property2": "string"
    },
    "systemAsset": true,
    "fileLocation": "string",
    "error": true,
    "fromContentTypeIds": [
      0
    ],
    "assetProperties": {
      "property1": {},
      "property2": {}
    }
  }
}

Properties

Name Type Required Restrictions Description
edges [PackageEdge] false none none

PageLayoutDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroupCount": 0,
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "syntaxType": 0,
  "status": 0,
  "headerCode": "string",
  "footerCode": "string",
  "stylesheetCode": "string",
  "fileExtension": "string",
  "contentLayout": "string",
  "currentVersion": "string",
  "language": "string",
  "layoutProcessor": 0,
  "typeContent": "string",
  "showOwner": true,
  "fullyAccessible": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
editable boolean false none none

PageLayoutGroupDTO

{
  "groupName": "string",
  "pageLayoutMetaData": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "editable": true,
      "primaryGroup": {},
      "sharedGroupCount": 0,
      "sharedGroups": [
        null
      ],
      "lock": {},
      "fullyAccessible": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
groupName string false none none
pageLayoutMetaData [PageLayoutMetaDataDTO] false none none

PageLayoutMetaDataDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroupCount": 0,
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-08-24T14:15:22Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true,
    "language": "string"
  },
  "fullyAccessible": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
editable boolean false none none

PagingInfo

{
  "searchString": "string",
  "currentPage": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "totalPages": 0,
  "totalRows": 0,
  "firstElementIndex": 0,
  "lastElementIndex": 0,
  "totalRowsInReport": 0
}

Properties

Name Type Required Restrictions Description
searchString string false none none
currentPage integer(int32) false none none
pageSize integer(int32) false none none
sortField string false none none
sortOrder string false none none
totalPages integer(int32) false none none
totalRows integer(int32) false none none
firstElementIndex integer(int32) false none none
lastElementIndex integer(int32) false none none
totalRowsInReport integer(int32) false none none

Enumerated Values

Property Value
sortOrder ASC
sortOrder DESC

PartnerDetails

{
  "name": "string",
  "partnerSalutation": "string",
  "partnerFirstname": "string",
  "partnerLastname": "string"
}

Properties

Name Type Required Restrictions Description
name string false none none
partnerSalutation string false none none
partnerFirstname string false none none
partnerLastname string false none none

Password

{
  "salt": "string",
  "hashedPassword": "string",
  "hashIterations": 0
}

Properties

Name Type Required Restrictions Description
salt string false none none
hashedPassword string false none none
hashIterations integer(int32) false none none

PaymentGateway

{
  "gatewayName": "string",
  "requiredChargeConfigurationOptions": [
    "string"
  ],
  "requiredSetupConfigurationOptions": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
gatewayName string false none none
requiredChargeConfigurationOptions [string] false none none
requiredSetupConfigurationOptions [string] false none none

PaymentGatewayProfile

{
  "id": 0,
  "customerId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
customerId integer(int32) false none none
name string false none none
description string false none none
type string false none none
lastModified string(date-time) false none none
properties object false none none
» additionalProperties string false none none

PersistentLanguageOptions

{
  "override": true,
  "type": 0,
  "default": true,
  "id": 0,
  "persistentLanguage": "string"
}

Properties

Name Type Required Restrictions Description
override boolean false none none
type integer(int32) false none none
default boolean false none none
id integer(int32) false none none
persistentLanguage string false none none

PredefinedList

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "sortType": 0,
  "persistentLanguageOptions": {
    "override": true,
    "type": 0,
    "default": true,
    "id": 0,
    "persistentLanguage": "string"
  },
  "duplicate": true,
  "default": true,
  "entries": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "language": "string",
  "id": 0,
  "override": true,
  "visible": true
}

Properties

None

PredefinedListDTO

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "sortType": 0,
  "persistentLanguageOptions": {
    "override": true,
    "type": 0,
    "default": true,
    "id": 0,
    "persistentLanguage": "string"
  },
  "duplicate": true,
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "listEntriesWithListSubLists": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "cteWithListsAsElements": [
    {
      "name": "string",
      "description": "string",
      "typeID": 0,
      "type": {},
      "maxSize": 0,
      "compulsory": true,
      "sequence": 0,
      "alias": "string",
      "defaultValue": "string",
      "id": 0,
      "contentType": 0,
      "listId": 0
    }
  ],
  "formsUsingThisList": [
    {
      "formId": 0,
      "elementLabel": "string"
    }
  ],
  "sortingEnabled": true,
  "sharedGroupCount": 0,
  "defaultLanguageSetInAnotherLanguage": true,
  "fullyAccessible": true,
  "listOverriddenInAnotherLanguage": true,
  "id": 0,
  "default": true,
  "entries": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "language": "string",
  "override": true,
  "visible": true
}

Properties

None

PredefinedListEntry

{
  "language": "string",
  "name": "string",
  "value": "string",
  "sequence": 0,
  "id": 0,
  "selectedByDefault": true,
  "subListID": 0,
  "listID": 0,
  "subList": {
    "key": {
      "id": null,
      "language": null
    },
    "name": "string",
    "description": "string",
    "sortType": 0,
    "persistentLanguageOptions": {
      "override": null,
      "type": null,
      "default": null,
      "id": null,
      "persistentLanguage": null
    },
    "duplicate": true,
    "default": true,
    "entries": [
      {}
    ],
    "language": "string",
    "id": 0,
    "override": true,
    "visible": true
  }
}

Properties

Name Type Required Restrictions Description
language string false none none
name string true none none
value string false none none
sequence integer(int32) false none none
id integer(int32) false none none
selectedByDefault boolean false none none
subListID integer(int32) false none none
listID integer(int32) false none none

PredefinedListMetaData

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "language": "string",
  "id": 0
}

Properties

None

PredefinedListMetaDataDTO

{
  "key": {
    "id": 0,
    "language": "string"
  },
  "name": "string",
  "description": "string",
  "editable": true,
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": null,
      "name": null,
      "description": null,
      "emailAddress": null,
      "createDate": null,
      "enabled": null,
      "ldap": null,
      "defaultChannel": null,
      "deleted": null
    },
    "assetID": 0,
    "groupID": 0,
    "assetType": 0,
    "readLevel": 0,
    "groupName": "string"
  },
  "sharedGroupCount": 0,
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {},
      "assetID": 0,
      "groupID": 0,
      "assetType": 0,
      "readLevel": 0,
      "groupName": "string"
    }
  ],
  "listEntriesWithListSubLists": [
    {
      "language": "string",
      "name": "string",
      "value": "string",
      "sequence": 0,
      "id": 0,
      "selectedByDefault": true,
      "subListID": 0,
      "listID": 0,
      "subList": {}
    }
  ],
  "cteWithListsAsElements": [
    {
      "name": "string",
      "description": "string",
      "typeID": 0,
      "type": {},
      "maxSize": 0,
      "compulsory": true,
      "sequence": 0,
      "alias": "string",
      "defaultValue": "string",
      "id": 0,
      "contentType": 0,
      "listId": 0
    }
  ],
  "formsUsingThisList": [
    {
      "formId": 0,
      "elementLabel": "string"
    }
  ],
  "fullyAccessible": true,
  "language": "string",
  "id": 0
}

Properties

None

PreviewFilterDTO

{
  "id": 0,
  "name": "string",
  "enabled": true,
  "method": 0,
  "url": "string",
  "dir": "string",
  "extension": "string",
  "passThru": "string",
  "params": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
enabled boolean false none none
method integer(int32) false none none
url string false none none
dir string false none none
extension string false none none
passThru string false none none
params [string] false none none

PublishOutput

{
  "lines": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
lines [string] false none none

PublishProcessorMetaData

{
  "id": 0,
  "name": "string",
  "processableType": 0,
  "description": "string",
  "enabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
name string true none none
processableType integer(int32) true none none
description string true none none
enabled boolean true none none

PurgeRequestDTO

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

Properties

Name Type Required Restrictions Description
languageCode string false none none
contentIds [integer] false none none

PushContentRequestDTO

{
  "contentIds": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
contentIds [integer] false none none

PxlConfigurationDTO

{
  "privateIpMatching": true,
  "clientOrgId": "string",
  "pxlEnabled": true,
  "environmentIdentifier": "string",
  "valid": true
}

Properties

Name Type Required Restrictions Description
privateIpMatching boolean false none none
clientOrgId string false none none
pxlEnabled boolean false none none
environmentIdentifier string false none none
valid boolean false none none

PxlFilter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "url": "string",
  "lastModified": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
url string false none none
lastModified string(date-time) false none none

PxlFilterDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "filterUrl": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
filterUrl string false none none

PxlFilterListDTO

{
  "id": 0,
  "name": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none

PxlFilterSimpleListDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

PxlFilterTableData

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "pxlFilters": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "url": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ],
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "url": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
draw integer(int32) false none none
recordsTotal integer(int32) false none none
recordsFiltered integer(int32) false none none
pxlFilters [PxlFilter] false none none

PxlFilterUniqueNameDTO

{
  "value": "string",
  "inputIsValid": true
}

Properties

Name Type Required Restrictions Description
value string false none none
inputIsValid boolean false none none

PxlGlobalConfigDTO

{
  "globalPxlSet": true
}

Properties

Name Type Required Restrictions Description
globalPxlSet boolean false none none

RecaptchaConfig

{
  "id": 0,
  "siteKey": "string",
  "secretKey": "string",
  "enabled": true,
  "enforced": true,
  "customerId": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
siteKey string false none none
secretKey string false none none
enabled boolean false none none
enforced boolean false none none
customerId integer(int32) false none none

RecaptchaDTO

{
  "enabled": true,
  "enforced": true
}

Properties

Name Type Required Restrictions Description
enabled boolean false none none
enforced boolean false none none

Recipient

{
  "type": "string",
  "id": 0,
  "level": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
type string false none none
id integer(int32) false none none
level string false none none
name string false none none

ReferencedAssets

{
  "graph": {
    "vertices": [
      {}
    ],
    "edges": [
      {}
    ]
  }
}

Properties

None

Report

{
  "reportType": "IMPORT",
  "entries": [
    {
      "asset": {},
      "action": "[",
      "status": "[",
      "date": "string",
      "error": "string",
      "packageName": "string"
    }
  ],
  "error": true,
  "importReportDirectory": "string",
  "packageName": "string",
  "errorReportEntry": {
    "asset": {
      "id": null,
      "assetType": null,
      "fromSection": null,
      "languageCode": null,
      "fromContentId": null,
      "names": null,
      "systemAsset": null,
      "fileLocation": null,
      "error": null,
      "fromContentTypeIds": null,
      "assetProperties": null
    },
    "action": "RESOLVE",
    "status": "SUCCESS",
    "date": "string",
    "error": "string",
    "packageName": "string"
  }
}

Properties

Name Type Required Restrictions Description
reportType string false none none
entries [ReportEntry] false none none

Enumerated Values

Property Value
reportType IMPORT
reportType EXPORT

ReportEntry

{
  "asset": {
    "id": 0,
    "assetType": "CONTENT",
    "fromSection": 0,
    "languageCode": "string",
    "fromContentId": 0,
    "names": {
      "property1": "string",
      "property2": "string"
    },
    "systemAsset": true,
    "fileLocation": "string",
    "error": true,
    "fromContentTypeIds": [
      0
    ],
    "assetProperties": {
      "property1": {},
      "property2": {}
    }
  },
  "action": "RESOLVE",
  "status": "SUCCESS",
  "date": "string",
  "error": "string",
  "packageName": "string"
}

Properties

None

ReportID

{
  "id": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none

ReportUrl

{
  "url": "string"
}

Properties

Name Type Required Restrictions Description
url string false none none

ResetChannelContent

{
  "id": 0,
  "name": "string",
  "sections": {
    "property1": "string",
    "property2": "string"
  },
  "sectionID": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
sections object false none none
» additionalProperties string false none none
sectionID integer(int32) false none none

ResetRequest

{
  "username": "string",
  "nonce": "string"
}

Properties

Name Type Required Restrictions Description
username string false none none
nonce string false none none

ResourceBundle

{
  "locale": {
    "language": "string",
    "displayName": "string",
    "script": "string",
    "country": "string",
    "variant": "string",
    "extensionKeys": [
      "string"
    ],
    "unicodeLocaleAttributes": [
      "string"
    ],
    "unicodeLocaleKeys": [
      "string"
    ],
    "iso3Language": "string",
    "iso3Country": "string",
    "displayLanguage": "string",
    "displayScript": "string",
    "displayCountry": "string",
    "displayVariant": "string"
  },
  "keys": {},
  "baseBundleName": "string"
}

Properties

None

Restrictions

{
  "content": "string",
  "user": "string",
  "channel": "string",
  "workflow": "string",
  "contentType": "string",
  "language": "string"
}

Properties

Name Type Required Restrictions Description
content string false none none
user string false none none
channel string false none none
workflow string false none none
contentType string false none none
language string false none none

ResultSetPage

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

Properties

Name Type Required Restrictions Description
rows [Row] false none none

ResultSetPageBrokenLinksRow

{
  "rows": [
    {
      "content": {},
      "language": "string",
      "sections": [
        null
      ],
      "type": "[",
      "responseCode": 0,
      "errorMessage": "string",
      "url": "string",
      "contentTypeID": 0,
      "contentTypeElementIDs": [
        null
      ]
    }
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

Properties

Name Type Required Restrictions Description
rows [BrokenLinksRow] false none none

ResultSetPageContentOwnerRow

{
  "rows": [
    {
      "content": {},
      "owner": {},
      "sections": [
        null
      ],
      "lastModified": "2019-08-24T14:15:22Z",
      "status": 0
    }
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

Properties

Name Type Required Restrictions Description
rows [ContentOwnerRow] false none none

ResultSetPageObject

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

Properties

Name Type Required Restrictions Description
rows [object] false none none

ResultSetPageRow

{
  "rows": [
    {}
  ],
  "pagingInfo": {
    "searchString": "string",
    "currentPage": 0,
    "pageSize": 0,
    "sortField": "string",
    "sortOrder": "ASC",
    "totalPages": 0,
    "totalRows": 0,
    "firstElementIndex": 0,
    "lastElementIndex": 0,
    "totalRowsInReport": 0
  },
  "details": {},
  "totalPages": 0,
  "sortOrder": "ASC",
  "pageSize": 0,
  "currentPage": 0,
  "searchString": "string",
  "sortField": "string",
  "firstElementIndex": 0,
  "totalRowsInReport": 0,
  "lastElementIndex": 0
}

Properties

Name Type Required Restrictions Description
rows [Row] false none none

Row

{}

Properties

None

SchedulableJobDTO

{
  "key": "string",
  "name": "string",
  "type": "string",
  "description": "string",
  "jobClass": "string"
}

Properties

Name Type Required Restrictions Description
key string false none none
name string false none none
type string false none none
description string false none none
jobClass string false none none

ScheduledJob

{
  "id": 0,
  "name": "string",
  "status": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "nextDue": "2019-08-24T14:15:22Z",
  "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": [
      "string"
    ],
    "recipients": [
      0
    ]
  },
  "parameters": {
    "property1": {
      "scheduledJob": {},
      "key": "string",
      "value": "string"
    },
    "property2": {
      "scheduledJob": {},
      "key": "string",
      "value": "string"
    }
  },
  "maximumExecutions": 0,
  "jobDescription": "string",
  "jobName": "string",
  "jobKey": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
status integer(int32) false none none
creationDate string(date-time) false none none
nextDue string(date-time) true none none
fixedRate boolean false none none
executionInterval integer(int32) true none none
executionCount integer(int32) false none none
maximumExecutions integer(int32) false none none
jobDescription string false none none
jobName string false none none
jobKey string false none none

ScheduledJobParameter

{
  "scheduledJob": {
    "id": 0,
    "name": "string",
    "status": 0,
    "creationDate": "2019-08-24T14:15:22Z",
    "nextDue": "2019-08-24T14:15:22Z",
    "fixedRate": true,
    "executionInterval": 0,
    "executionCount": 0,
    "alert": {
      "id": null,
      "from": null,
      "header": null,
      "message": null,
      "level": null,
      "type": null,
      "userRecipients": null,
      "groupRecipients": null,
      "dispatchMedia": null,
      "emailRecipients": null,
      "emailSender": null,
      "attachments": null,
      "recipients": null
    },
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "maximumExecutions": 0,
    "jobDescription": "string",
    "jobName": "string",
    "jobKey": "string"
  },
  "key": "string",
  "value": "string"
}

Properties

None

SearchResponse

{
  "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
}

Properties

Name Type Required Restrictions Description
type string false none none
path string false none none
id integer(int32) false none none
lang string false none none
lastModified string false none none
name string false none none
status string false none none
smName string false none none
version string false none none
sectionId integer(int32) false none none
title string false none none
template string false none none
expired boolean false none none
lastModifiedBy string false none none
readOnly boolean false none none
content boolean false none none

SearchResponseDTO

{
  "type": "string",
  "id": 0,
  "lastModified": "string",
  "name": "string",
  "status": "string",
  "title": "string",
  "lastModifiedBy": "string"
}

Properties

Name Type Required Restrictions Description
type string false none none
id integer(int32) false none none
lastModified string false none none
name string false none none
status string false none none
title string false none none
lastModifiedBy string false none none

Section

{
  "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-08-24T14:15:22Z",
      "lastLoginDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "password": {},
      "defaultPreviewChannel": 0,
      "preferredHtmlEditor": 0,
      "extranetConsent": true,
      "extranetAccess": "string",
      "extranetConsentDatetime": "2019-08-24T14:15:22Z",
      "groups": [
        null
      ],
      "extensibleUserObjectContent": {},
      "sections": [
        null
      ],
      "userChannels": [
        null
      ],
      "locale": {},
      "fullName": "string",
      "deleted": true,
      "powerUser": true,
      "administrator": true,
      "authLevel": 0,
      "fullTinyMCELocaleCode": "string",
      "appliedPreviewChannel": 0,
      "propertyResourceBundle": {},
      "fullLocaleCode": "string"
    }
  ],
  "viewUsers": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "emailAddress": "string",
      "defaultLang": "string",
      "localeCountryCode": "string",
      "localeLanguageCode": "string",
      "localeVariant": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "lastLoginDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "password": {},
      "defaultPreviewChannel": 0,
      "preferredHtmlEditor": 0,
      "extranetConsent": true,
      "extranetAccess": "string",
      "extranetConsentDatetime": "2019-08-24T14:15:22Z",
      "groups": [
        null
      ],
      "extensibleUserObjectContent": {},
      "sections": [
        null
      ],
      "userChannels": [
        null
      ],
      "locale": {},
      "fullName": "string",
      "deleted": true,
      "powerUser": true,
      "administrator": true,
      "authLevel": 0,
      "fullTinyMCELocaleCode": "string",
      "appliedPreviewChannel": 0,
      "propertyResourceBundle": {},
      "fullLocaleCode": "string"
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "children": [
        null
      ],
      "sections": [
        null
      ],
      "steps": [
        null
      ],
      "deleted": true,
      "memberCount": 0
    }
  ],
  "viewGroups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "children": [
        null
      ],
      "sections": [
        null
      ],
      "steps": [
        null
      ],
      "deleted": true,
      "memberCount": 0
    }
  ],
  "contentSections": [
    {
      "section": {},
      "content": {},
      "printSequence": 0,
      "sortLock": "[",
      "sectionID": 0,
      "entityID": 0,
      "contentID": 0
    }
  ],
  "sectionInfos": {
    "property1": {
      "section": {},
      "language": "string",
      "name": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "outputUri": "string",
      "outputFilename": "string",
      "keyPhrase": "string",
      "accessKey": "string",
      "contentOwner": 0,
      "metaDatas": [
        null
      ]
    },
    "property2": {
      "section": {},
      "language": "string",
      "name": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "outputUri": "string",
      "outputFilename": "string",
      "keyPhrase": "string",
      "accessKey": "string",
      "contentOwner": 0,
      "metaDatas": [
        null
      ]
    }
  },
  "mirrorSections": [
    {
      "id": 0,
      "level": 0,
      "status": 0,
      "printSequence": 0,
      "formSection": true,
      "archived": true,
      "users": [
        null
      ],
      "viewUsers": [
        null
      ],
      "groups": [
        null
      ],
      "viewGroups": [
        null
      ],
      "contentSections": [
        null
      ],
      "sectionInfos": {},
      "mirrorSections": [
        null
      ],
      "links": {},
      "rootChannels": [
        null
      ],
      "appliedPageLayouts": [
        null
      ],
      "hierarchyMirrorAcOpt": {},
      "hierarchyMirrorMetadataOpt": {},
      "children": [
        null
      ],
      "contentTypeScopes": [
        null
      ],
      "cloneSource": {},
      "sectionPaths": {},
      "sortLock": "[",
      "parent": {},
      "mirrors": [
        null
      ],
      "root": true,
      "shown": true,
      "nextSequence": 0,
      "entityID": 0,
      "childOfMirrored": true,
      "metadataOption": 0,
      "workflowID": 0,
      "childOfMirror": true,
      "workflowName": "string",
      "workflow": {},
      "channelRoot": [
        null
      ],
      "languages": [
        null
      ],
      "channels": [
        null
      ],
      "pathMembers": [
        null
      ],
      "sectionSortMethod": 0,
      "contentSortMethod": 0,
      "contentsAndSequences": {},
      "parentWorkflowID": 0,
      "inheritedPageLayouts": {},
      "currentOrInheritedWorkflow": 0,
      "contentNextSequence": 0,
      "accessControlOption": 0,
      "parentID": 0,
      "mirror": true,
      "allNames": {},
      "languageCount": 0,
      "mirrorSource": {},
      "link": true,
      "mirrorSourceID": 0
    }
  ],
  "links": {
    "property1": {
      "sourceSection": {},
      "language": "string",
      "url": "string",
      "section": 0,
      "target": "string",
      "inheritedAccessControl": 0,
      "overrideLink": true,
      "linkHasBeenOverridden": true,
      "type": 0,
      "sourceSectionID": 0,
      "persistentLanguage": "string"
    },
    "property2": {
      "sourceSection": {},
      "language": "string",
      "url": "string",
      "section": 0,
      "target": "string",
      "inheritedAccessControl": 0,
      "overrideLink": true,
      "linkHasBeenOverridden": true,
      "type": 0,
      "sourceSectionID": 0,
      "persistentLanguage": "string"
    }
  },
  "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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    }
  ],
  "appliedPageLayouts": [
    {
      "id": {},
      "sectionID": 0,
      "pageLayoutID": 0,
      "inheritablePageLayoutID": 0,
      "channel": {},
      "section": {},
      "channelName": "string",
      "channelID": 0
    }
  ],
  "hierarchyMirrorAcOpt": {
    "section": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "accessControlOption": 0,
    "id": 0
  },
  "hierarchyMirrorMetadataOpt": {
    "section": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "metadataOption": 0,
    "id": 0
  },
  "children": [
    {
      "id": 0,
      "level": 0,
      "status": 0,
      "printSequence": 0,
      "formSection": true,
      "archived": true,
      "users": [
        null
      ],
      "viewUsers": [
        null
      ],
      "groups": [
        null
      ],
      "viewGroups": [
        null
      ],
      "contentSections": [
        null
      ],
      "sectionInfos": {},
      "mirrorSections": [
        null
      ],
      "links": {},
      "rootChannels": [
        null
      ],
      "appliedPageLayouts": [
        null
      ],
      "hierarchyMirrorAcOpt": {},
      "hierarchyMirrorMetadataOpt": {},
      "children": [
        null
      ],
      "contentTypeScopes": [
        null
      ],
      "cloneSource": {},
      "sectionPaths": {},
      "sortLock": "[",
      "parent": {},
      "mirrors": [
        null
      ],
      "root": true,
      "shown": true,
      "nextSequence": 0,
      "entityID": 0,
      "childOfMirrored": true,
      "metadataOption": 0,
      "workflowID": 0,
      "childOfMirror": true,
      "workflowName": "string",
      "workflow": {},
      "channelRoot": [
        null
      ],
      "languages": [
        null
      ],
      "channels": [
        null
      ],
      "pathMembers": [
        null
      ],
      "sectionSortMethod": 0,
      "contentSortMethod": 0,
      "contentsAndSequences": {},
      "parentWorkflowID": 0,
      "inheritedPageLayouts": {},
      "currentOrInheritedWorkflow": 0,
      "contentNextSequence": 0,
      "accessControlOption": 0,
      "parentID": 0,
      "mirror": true,
      "allNames": {},
      "languageCount": 0,
      "mirrorSource": {},
      "link": true,
      "mirrorSourceID": 0
    }
  ],
  "contentTypeScopes": [
    {
      "section": {},
      "contentType": {},
      "scope": 0,
      "contentTypeID": 0
    }
  ],
  "cloneSource": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "sectionPaths": {
    "property1": {
      "section": {},
      "language": "string",
      "path": "string"
    },
    "property2": {
      "section": {},
      "language": "string",
      "path": "string"
    }
  },
  "sortLock": "TOP",
  "parent": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "mirrors": [
    0
  ],
  "root": true,
  "shown": true,
  "nextSequence": 0,
  "entityID": 0,
  "childOfMirrored": true,
  "metadataOption": 0,
  "workflowID": 0,
  "childOfMirror": true,
  "workflowName": "string",
  "workflow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "contentTypes": [
      {}
    ],
    "section": [
      {}
    ],
    "workflowSteps": [
      {}
    ],
    "restricted": true,
    "firstStep": {
      "id": null,
      "name": null,
      "description": null,
      "lastModified": null,
      "priority": null,
      "restrictToEditors": null,
      "language": null,
      "users": null,
      "groups": null,
      "options": null,
      "workflowSteps": null
    }
  },
  "channelRoot": [
    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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    }
  ],
  "pathMembers": [
    0
  ],
  "sectionSortMethod": 0,
  "contentSortMethod": 0,
  "contentsAndSequences": {
    "property1": 0,
    "property2": 0
  },
  "parentWorkflowID": 0,
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "currentOrInheritedWorkflow": 0,
  "contentNextSequence": 0,
  "accessControlOption": 0,
  "parentID": 0,
  "mirror": true,
  "allNames": {
    "property1": "string",
    "property2": "string"
  },
  "languageCount": 0,
  "mirrorSource": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "link": true,
  "mirrorSourceID": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
level integer(int32) false none none
status integer(int32) false none none
printSequence integer(int32) false none none
formSection boolean false none none
archived boolean false none none
users [User] false none none
mirrorSections [Section] false none none
rootChannels [Channel] false none none
sortLock string false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

SectionChildListingDto

{
  "children": [
    {}
  ],
  "sortType": 0
}

Properties

Name Type Required Restrictions Description
children [object] false none none
sortType integer(int32) false none none

SectionChildListingDtoSectionContentDto

{
  "children": [
    {
      "id": 0,
      "content": {},
      "printSequence": 0,
      "sortLock": "["
    }
  ],
  "sortType": 0
}

Properties

Name Type Required Restrictions Description
children [SectionContentDto] false none none

SectionChildListingDtoSectionMetaDataDTO

{
  "children": [
    {
      "id": 0,
      "name": "string",
      "language": "string",
      "description": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "sortLock": "["
    }
  ],
  "sortType": 0
}

Properties

Name Type Required Restrictions Description
children [SectionMetaDataDTO] false none none

SectionContentDto

{
  "id": 0,
  "content": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "locked": true,
    "sectionIDs": [
      0
    ]
  },
  "printSequence": 0,
  "sortLock": "TOP"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none

SectionDTO

{
  "id": 0,
  "parent": 0,
  "name": "string",
  "description": "string",
  "outputUrl": "string",
  "outputFilename": "string",
  "accessKey": "string",
  "keyPhrase": "string",
  "status": 0,
  "workflow": 0,
  "parentWorkflowName": "string",
  "show": true,
  "iseForm": true,
  "archive": true,
  "lastModified": "2019-08-24T14:15:22Z",
  "printSequence": 0,
  "contentSortMethod": 0,
  "sectionSortMethod": 0,
  "path": "string",
  "mirrorOf": 0,
  "sourceOfMirror": true,
  "link": true,
  "channels": [
    {
      "id": 0,
      "pageLayout": 0,
      "inheritedPageLayout": 0,
      "valid": true
    }
  ],
  "userIDs": [
    0
  ],
  "inheritedUserIDs": [
    0
  ],
  "groupIDs": [
    0
  ],
  "inheritedGroupIDs": [
    0
  ],
  "viewUserIDs": [
    0
  ],
  "viewGroupIDs": [
    0
  ],
  "contentTypeScopes": [
    {
      "id": 0,
      "scope": 0,
      "inherited": true
    }
  ],
  "metaDatas": [
    {
      "id": 0,
      "value": "string",
      "lang": "string"
    }
  ],
  "linkInfo": {
    "type": 0,
    "section": 0,
    "url": "string",
    "language": "string",
    "target": "string",
    "accessControl": 0,
    "override": true,
    "overridden": true
  },
  "excludedMirrorSections": [
    0
  ],
  "workflowName": "string",
  "parentWorkflowID": 0,
  "accessControl": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "metaData": {
    "id": 0,
    "type": 0,
    "enabled": true,
    "active": true
  },
  "pathMembers": [
    0
  ],
  "sortLock": "TOP",
  "editable": true,
  "inheritedLinkSection": true,
  "accessControlEnabled": true,
  "accessControlType": 0,
  "metaDataType": 0,
  "accessControlInherited": true,
  "allowedGroups": [
    0
  ],
  "mirrorOfPath": "string",
  "inheritedPageLayouts": {
    "property1": 0,
    "property2": 0
  },
  "outputUriEnabled": true,
  "publishEnabled": true,
  "outputFilenameEnabled": true,
  "spellCheckEnabled": true,
  "pathAsOutputUriEnabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
parent integer(int32) false none none
name string false none none
description string false none none
outputUrl string false none none
outputFilename string false none none
accessKey string false none none
keyPhrase string false none none
status integer(int32) false none none
workflow integer(int32) false none none
parentWorkflowName string false none none
show boolean false none none
iseForm boolean false none none
archive boolean false none none
lastModified string(date-time) false none none
printSequence integer(int32) false none none
contentSortMethod integer(int32) false none none
sectionSortMethod integer(int32) false none none
path string false none none
mirrorOf integer(int32) false none none
sourceOfMirror boolean false none none
link boolean false none none
channels [AppliedPageLayoutsDTO] false none none

SectionInfo

{
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "language": "string",
  "name": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "outputUri": "string",
  "outputFilename": "string",
  "keyPhrase": "string",
  "accessKey": "string",
  "contentOwner": 0,
  "metaDatas": [
    {
      "sectionInfo": {},
      "metaTag": {},
      "value": "string",
      "language": "string",
      "sectionID": 0,
      "metaTagName": "string",
      "metaTagID": 0
    }
  ]
}

Properties

None

SectionListing

{
  "id": 0,
  "name": "string",
  "path": "string",
  "mirroredSections": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
path string false none none
mirroredSections [string] false none none

SectionMetaDataDTO

{
  "id": 0,
  "name": "string",
  "language": "string",
  "description": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "sortLock": "TOP"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
language string false none none
description string false none none
lastModified string(date-time) false none none
sortLock string false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

SectionPath

{
  "section": {
    "id": 0,
    "level": 0,
    "status": 0,
    "printSequence": 0,
    "formSection": true,
    "archived": true,
    "users": [
      {}
    ],
    "viewUsers": [
      {}
    ],
    "groups": [
      {}
    ],
    "viewGroups": [
      {}
    ],
    "contentSections": [
      {}
    ],
    "sectionInfos": {
      "property1": {},
      "property2": {}
    },
    "mirrorSections": [
      {}
    ],
    "links": {
      "property1": {},
      "property2": {}
    },
    "rootChannels": [
      {}
    ],
    "appliedPageLayouts": [
      {}
    ],
    "hierarchyMirrorAcOpt": {
      "section": null,
      "accessControlOption": null,
      "id": null
    },
    "hierarchyMirrorMetadataOpt": {
      "section": null,
      "metadataOption": null,
      "id": null
    },
    "children": [
      {}
    ],
    "contentTypeScopes": [
      {}
    ],
    "cloneSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "sectionPaths": {
      "property1": {},
      "property2": {}
    },
    "sortLock": "TOP",
    "parent": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "mirrors": [
      0
    ],
    "root": true,
    "shown": true,
    "nextSequence": 0,
    "entityID": 0,
    "childOfMirrored": true,
    "metadataOption": 0,
    "workflowID": 0,
    "childOfMirror": true,
    "workflowName": "string",
    "workflow": {
      "id": null,
      "name": null,
      "description": null,
      "creationDate": null,
      "lastModified": null,
      "contentTypes": null,
      "section": null,
      "workflowSteps": null,
      "restricted": null,
      "firstStep": null
    },
    "channelRoot": [
      0
    ],
    "languages": [
      "string"
    ],
    "channels": [
      {}
    ],
    "pathMembers": [
      0
    ],
    "sectionSortMethod": 0,
    "contentSortMethod": 0,
    "contentsAndSequences": {
      "property1": 0,
      "property2": 0
    },
    "parentWorkflowID": 0,
    "inheritedPageLayouts": {
      "property1": 0,
      "property2": 0
    },
    "currentOrInheritedWorkflow": 0,
    "contentNextSequence": 0,
    "accessControlOption": 0,
    "parentID": 0,
    "mirror": true,
    "allNames": {
      "property1": "string",
      "property2": "string"
    },
    "languageCount": 0,
    "mirrorSource": {
      "id": null,
      "level": null,
      "status": null,
      "printSequence": null,
      "formSection": null,
      "archived": null,
      "users": null,
      "viewUsers": null,
      "groups": null,
      "viewGroups": null,
      "contentSections": null,
      "sectionInfos": null,
      "mirrorSections": null,
      "links": null,
      "rootChannels": null,
      "appliedPageLayouts": null,
      "hierarchyMirrorAcOpt": null,
      "hierarchyMirrorMetadataOpt": null,
      "children": null,
      "contentTypeScopes": null,
      "cloneSource": null,
      "sectionPaths": null,
      "sortLock": null,
      "parent": null,
      "mirrors": null,
      "root": null,
      "shown": null,
      "nextSequence": null,
      "entityID": null,
      "childOfMirrored": null,
      "metadataOption": null,
      "workflowID": null,
      "childOfMirror": null,
      "workflowName": null,
      "workflow": null,
      "channelRoot": null,
      "languages": null,
      "channels": null,
      "pathMembers": null,
      "sectionSortMethod": null,
      "contentSortMethod": null,
      "contentsAndSequences": null,
      "parentWorkflowID": null,
      "inheritedPageLayouts": null,
      "currentOrInheritedWorkflow": null,
      "contentNextSequence": null,
      "accessControlOption": null,
      "parentID": null,
      "mirror": null,
      "allNames": null,
      "languageCount": null,
      "mirrorSource": null,
      "link": null,
      "mirrorSourceID": null
    },
    "link": true,
    "mirrorSourceID": 0
  },
  "language": "string",
  "path": "string"
}

Properties

None

ServerSideLinkDTO

{
  "id": 0,
  "fromSection": 0,
  "toSection": 0,
  "fromContent": 0,
  "toContent": 0,
  "linkText": "string",
  "language": "string",
  "toLanguage": "string",
  "attributes": {
    "property1": "string",
    "property2": "string"
  },
  "path": "string",
  "fromContentName": "string",
  "fromSectionPath": "string",
  "active": true,
  "broken": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
fromSection integer(int32) false none none
toSection integer(int32) false none none
fromContent integer(int32) false none none
toContent integer(int32) false none none
linkText string false none none
language string false none none
toLanguage string false none none
attributes object false none none
» additionalProperties string false none none
path string false none none
fromContentName string false none none
fromSectionPath string false none none
active boolean false none none
broken boolean false none none

Settings

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none

SiteManagerMetaData

{
  "version": {
    "version": "string",
    "subMinor": 0,
    "major": 0,
    "minor": 0
  },
  "dbPatchLevel": 0
}

Properties

None

SiteStructure

{
  "id": 0,
  "name": "string",
  "plugin": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
plugin string false none none

SocialAccount

{
  "accountID": 0,
  "accountType": "string",
  "accountName": "string",
  "accountDescription": "string",
  "accountProperties": {
    "property1": "string",
    "property2": "string"
  },
  "accountPropertiesString": "string"
}

Properties

Name Type Required Restrictions Description
accountID integer(int32) false none none
accountType string false none none
accountName string false none none
accountDescription string false none none
accountProperties object false none none
» additionalProperties string false none none
accountPropertiesString string false none none

SocialPost

{
  "postID": 0,
  "socialAccount": {
    "accountID": 0,
    "accountType": "string",
    "accountName": "string",
    "accountDescription": "string",
    "accountProperties": {
      "property1": "string",
      "property2": "string"
    },
    "accountPropertiesString": "string"
  },
  "contentID": 0,
  "createdDate": "2019-08-24T14:15:22Z",
  "postedDate": "2019-08-24T14:15:22Z",
  "filename": "string",
  "baseURL": "string",
  "status": "sent",
  "postProperties": {
    "property1": "string",
    "property2": "string"
  },
  "postText": "string",
  "postDisplayText": "string",
  "postPropertiesString": "string"
}

Properties

Name Type Required Restrictions Description
postID integer(int32) false none none

StackTraceElement

{
  "classLoaderName": "string",
  "moduleName": "string",
  "moduleVersion": "string",
  "methodName": "string",
  "fileName": "string",
  "lineNumber": 0,
  "className": "string",
  "nativeMethod": true
}

Properties

Name Type Required Restrictions Description
classLoaderName string false none none
moduleName string false none none
moduleVersion string false none none
methodName string false none none
fileName string false none none
lineNumber integer(int32) false none none
className string false none none
nativeMethod boolean false none none

StepEntity

{
  "id": 0,
  "name": "string",
  "description": "string",
  "lastModified": "2019-08-24T14:15:22Z",
  "priority": "PRIORITY_LOWEST",
  "restrictToEditors": 0,
  "language": {
    "code": "string",
    "name": "string",
    "charset": "string",
    "disclaimer": "string",
    "channels": [
      {}
    ]
  },
  "users": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "emailAddress": "string",
      "defaultLang": "string",
      "localeCountryCode": "string",
      "localeLanguageCode": "string",
      "localeVariant": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "lastLoginDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "password": {},
      "defaultPreviewChannel": 0,
      "preferredHtmlEditor": 0,
      "extranetConsent": true,
      "extranetAccess": "string",
      "extranetConsentDatetime": "2019-08-24T14:15:22Z",
      "groups": [
        null
      ],
      "extensibleUserObjectContent": {},
      "sections": [
        null
      ],
      "userChannels": [
        null
      ],
      "locale": {},
      "fullName": "string",
      "deleted": true,
      "powerUser": true,
      "administrator": true,
      "authLevel": 0,
      "fullTinyMCELocaleCode": "string",
      "appliedPreviewChannel": 0,
      "propertyResourceBundle": {},
      "fullLocaleCode": "string"
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "children": [
        null
      ],
      "sections": [
        null
      ],
      "steps": [
        null
      ],
      "deleted": true,
      "memberCount": 0
    }
  ],
  "options": {
    "id": 0,
    "stepEntity": {
      "id": null,
      "name": null,
      "description": null,
      "lastModified": null,
      "priority": null,
      "restrictToEditors": null,
      "language": null,
      "users": null,
      "groups": null,
      "options": null,
      "workflowSteps": null
    },
    "rejectType": "CONTENT_OWNER",
    "rejectStep": 0,
    "voteType": 0,
    "voteModerator": 0,
    "stepHour": 0,
    "stepDay": 0,
    "languageType": 0,
    "languageNumber": 0,
    "alertUser": "ALERT_OWNER",
    "alertMode": 0,
    "alertTypes": [
      0
    ]
  },
  "workflowSteps": [
    {
      "workflowEntity": {},
      "stepEntity": {},
      "sequence": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
lastModified string(date-time) false none none
priority string false none none
restrictToEditors integer(int32) false none none

Enumerated Values

Property Value
priority PRIORITY_LOWEST
priority PRIORITY_LOW
priority PRIORITY_NORMAL
priority PRIORITY_HIGH
priority PRIORITY_HIGHEST

StepEntityDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "stepPriority": 0,
  "users": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "rejectTo": 0,
  "stepXID": 0,
  "differentWorkflowID": 0,
  "stepDay": 0,
  "stepHour": 0,
  "vote": 0,
  "getxModerators": 0,
  "activeModeration": true,
  "alertType": [
    0
  ],
  "alertConfig": 0,
  "restrictToEditors": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
stepPriority integer(int32) false none none
users [UserMetaDataDTO] false none none

StepEntityInformation

{
  "id": 0,
  "name": "string",
  "description": "string",
  "users": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "rejectTo": 0,
  "stepXID": 0,
  "differentWorkflowID": 0,
  "stepDay": 0,
  "stepHour": 0,
  "vote": 0,
  "getxModerators": 0,
  "alertType": [
    0
  ],
  "alertConfig": 0,
  "stepXName": "string",
  "differentWorkflowName": "string",
  "uniqueUsers": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
users [UserMetaDataDTO] false none none

StepEntityMetaData

{
  "id": 0,
  "name": "string",
  "description": "string",
  "priority": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
priority integer(int32) false none none

StepOptionEntity

{
  "id": 0,
  "stepEntity": {
    "id": 0,
    "name": "string",
    "description": "string",
    "lastModified": "2019-08-24T14:15:22Z",
    "priority": "PRIORITY_LOWEST",
    "restrictToEditors": 0,
    "language": {
      "code": null,
      "name": null,
      "charset": null,
      "disclaimer": null,
      "channels": null
    },
    "users": [
      {}
    ],
    "groups": [
      {}
    ],
    "options": {
      "id": null,
      "stepEntity": null,
      "rejectType": null,
      "rejectStep": null,
      "voteType": null,
      "voteModerator": null,
      "stepHour": null,
      "stepDay": null,
      "languageType": null,
      "languageNumber": null,
      "alertUser": null,
      "alertMode": null,
      "alertTypes": null
    },
    "workflowSteps": [
      {}
    ]
  },
  "rejectType": "CONTENT_OWNER",
  "rejectStep": 0,
  "voteType": 0,
  "voteModerator": 0,
  "stepHour": 0,
  "stepDay": 0,
  "languageType": 0,
  "languageNumber": 0,
  "alertUser": "ALERT_OWNER",
  "alertMode": 0,
  "alertTypes": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none

SyntaxType

{
  "id": 0,
  "name": "string",
  "mimeCode": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
name string true none none
mimeCode string true none none

T4StreamWriter

{
  "outputStream": {},
  "encoding": "string",
  "writer": {}
}

Properties

None

Table

{
  "name": "string",
  "required": true,
  "primaryKey": [
    {
      "name": "string",
      "default": "string",
      "type": 0,
      "maxSize": 0,
      "unique": true,
      "indexed": true,
      "indexLength": 0,
      "primaryKey": true,
      "autoIncrement": true,
      "nullValuePermitted": true
    }
  ],
  "columnCount": 0,
  "columns": [
    {
      "name": "string",
      "default": "string",
      "type": 0,
      "maxSize": 0,
      "unique": true,
      "indexed": true,
      "indexLength": 0,
      "primaryKey": true,
      "autoIncrement": true,
      "nullValuePermitted": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string false none none
required boolean false none none
primaryKey [Column] false none none

TableData

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "id": 0,
      "keyName": "string",
      "keyDescription": "string",
      "lastModified": "2019-08-24T14:15:22Z",
      "keys": "string",
      "inUse": true,
      "usedFor": [
        null
      ],
      "itAPrivateKey": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
draw integer(int32) false none none
recordsTotal integer(int32) false none none
recordsFiltered integer(int32) false none none
data [KeyMeta] false none none

TableDataResponseStructure

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {}
  ],
  "error": "string"
}

Properties

Name Type Required Restrictions Description
draw integer(int32) false none none
recordsTotal integer(int32) false none none
recordsFiltered integer(int32) false none none
data [object] false none none
error string false none none

TableDataResponseStructureAPIKeyDTO

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "id": 0,
      "name": "string",
      "active": true,
      "deleted": true,
      "secret": [
        null
      ],
      "userId": 0,
      "lastModifiedBy": 0,
      "dateModified": "2019-08-24T14:15:22Z",
      "dateCreated": "2019-08-24T14:15:22Z",
      "invalidationDate": "2019-08-24T14:15:22Z",
      "expired": true
    }
  ],
  "error": "string"
}

Properties

Name Type Required Restrictions Description
draw integer(int32) false none none
recordsTotal integer(int32) false none none
recordsFiltered integer(int32) false none none
data [APIKeyDTO] false none none

Task

{
  "applicationEventPublisher": {},
  "writer": {
    "outputStream": {},
    "encoding": "string",
    "writer": {}
  },
  "status": "PENDING",
  "id": "string",
  "taskType": "string",
  "taskLevel": "string",
  "triggerStamp": "2019-08-24T14:15:22Z",
  "startedStamp": "2019-08-24T14:15:22Z",
  "completedStamp": "2019-08-24T14:15:22Z",
  "events": [
    {
      "source": {},
      "timestamp": 0,
      "task": {},
      "description": "string",
      "severity": "["
    }
  ],
  "user": {
    "id": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string",
    "defaultLang": "string",
    "localeCountryCode": "string",
    "localeLanguageCode": "string",
    "localeVariant": "string",
    "createDate": "2019-08-24T14:15:22Z",
    "lastLoginDate": "2019-08-24T14:15:22Z",
    "enabled": true,
    "password": {
      "salt": null,
      "hashedPassword": null,
      "hashIterations": null
    },
    "defaultPreviewChannel": 0,
    "preferredHtmlEditor": 0,
    "extranetConsent": true,
    "extranetAccess": "string",
    "extranetConsentDatetime": "2019-08-24T14:15:22Z",
    "groups": [
      {}
    ],
    "extensibleUserObjectContent": {
      "metaData": null,
      "elements": null,
      "language": null,
      "name": null,
      "owner": null,
      "id": null,
      "version": null,
      "lastModified": null,
      "status": null,
      "sections": null,
      "channelIDs": null,
      "contentTypeID": null,
      "expiryDate": null,
      "sectionIDs": null,
      "archiveSection": null,
      "reviewDate": null,
      "publishDate": null,
      "elementCount": null,
      "lastModifiedBy": null,
      "previousVersion": null
    },
    "sections": [
      {}
    ],
    "userChannels": [
      {}
    ],
    "locale": {
      "language": null,
      "displayName": null,
      "script": null,
      "country": null,
      "variant": null,
      "extensionKeys": null,
      "unicodeLocaleAttributes": null,
      "unicodeLocaleKeys": null,
      "iso3Language": null,
      "iso3Country": null,
      "displayLanguage": null,
      "displayScript": null,
      "displayCountry": null,
      "displayVariant": null
    },
    "fullName": "string",
    "deleted": true,
    "powerUser": true,
    "administrator": true,
    "authLevel": 0,
    "fullTinyMCELocaleCode": "string",
    "appliedPreviewChannel": 0,
    "propertyResourceBundle": {
      "locale": null,
      "keys": null,
      "baseBundleName": null
    },
    "fullLocaleCode": "string"
  },
  "selectedLanguage": "string",
  "typeName": "string",
  "reportID": 0,
  "jobID": 0,
  "thread": {
    "name": "string",
    "priority": 0,
    "daemon": true,
    "contextClassLoader": {
      "parent": null,
      "name": null,
      "unnamedModule": null,
      "registeredAsParallelCapable": null,
      "definedPackages": null
    },
    "uncaughtExceptionHandler": {},
    "interrupted": true,
    "threadGroup": {
      "parent": null,
      "name": null,
      "maxPriority": null,
      "destroyed": null,
      "daemon": null
    },
    "stackTrace": [
      {}
    ],
    "alive": true,
    "id": 0,
    "state": "NEW"
  },
  "typeKeyword": "string"
}

Properties

None

TaskEvent

{
  "source": {},
  "timestamp": 0,
  "task": {
    "applicationEventPublisher": {},
    "writer": {
      "outputStream": null,
      "encoding": null,
      "writer": null
    },
    "status": "PENDING",
    "id": "string",
    "taskType": "string",
    "taskLevel": "string",
    "triggerStamp": "2019-08-24T14:15:22Z",
    "startedStamp": "2019-08-24T14:15:22Z",
    "completedStamp": "2019-08-24T14:15:22Z",
    "events": [
      {}
    ],
    "user": {
      "id": null,
      "username": null,
      "firstName": null,
      "lastName": null,
      "emailAddress": null,
      "defaultLang": null,
      "localeCountryCode": null,
      "localeLanguageCode": null,
      "localeVariant": null,
      "createDate": null,
      "lastLoginDate": null,
      "enabled": null,
      "password": null,
      "defaultPreviewChannel": null,
      "preferredHtmlEditor": null,
      "extranetConsent": null,
      "extranetAccess": null,
      "extranetConsentDatetime": null,
      "groups": null,
      "extensibleUserObjectContent": null,
      "sections": null,
      "userChannels": null,
      "locale": null,
      "fullName": null,
      "deleted": null,
      "powerUser": null,
      "administrator": null,
      "authLevel": null,
      "fullTinyMCELocaleCode": null,
      "appliedPreviewChannel": null,
      "propertyResourceBundle": null,
      "fullLocaleCode": null
    },
    "selectedLanguage": "string",
    "typeName": "string",
    "reportID": 0,
    "jobID": 0,
    "thread": {
      "name": null,
      "priority": null,
      "daemon": null,
      "contextClassLoader": null,
      "uncaughtExceptionHandler": null,
      "interrupted": null,
      "threadGroup": null,
      "stackTrace": null,
      "alive": null,
      "id": null,
      "state": null
    },
    "typeKeyword": "string"
  },
  "description": "string",
  "severity": "EMERGENCY"
}

Properties

Name Type Required Restrictions Description
source object false none none
timestamp integer(int64) false none none

TaskMetaData

{
  "taskId": "string",
  "name": "string",
  "queuedTime": 0,
  "startTime": 0,
  "duration": "string",
  "type": "string",
  "isInprogress": true,
  "threadStatus": "string",
  "threadLevel": "string",
  "currentOutput": "string",
  "callStack": "string"
}

Properties

Name Type Required Restrictions Description
taskId string false none none
name string false none none
queuedTime integer(int64) false none none
startTime integer(int64) false none none
duration string false none none
type string false none none
isInprogress boolean false none none
threadStatus string false none none
threadLevel string false none none
currentOutput string false none none
callStack string false none none

TerminalfourLogDto

{
  "id": 0,
  "description": "string",
  "occurred": "2019-08-24T14:15:22Z",
  "severity": "string",
  "eventType": "string",
  "action": "string",
  "error": "string",
  "remoteAddress": "string",
  "language": "string",
  "content": "string",
  "section": "string",
  "user": "string",
  "stackTrace": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
description string false none none
occurred string(date-time) false none none
severity string false none none
eventType string false none none
action string false none none
error string false none none
remoteAddress string false none none
language string false none none
content string false none none
section string false none none
user string false none none
stackTrace string false none none

Thread

{
  "name": "string",
  "priority": 0,
  "daemon": true,
  "contextClassLoader": {
    "parent": {
      "parent": null,
      "name": null,
      "unnamedModule": null,
      "registeredAsParallelCapable": null,
      "definedPackages": null
    },
    "name": "string",
    "unnamedModule": {
      "layer": null,
      "name": null,
      "descriptor": null,
      "classLoader": null,
      "annotations": null,
      "declaredAnnotations": null,
      "named": null,
      "packages": null
    },
    "registeredAsParallelCapable": true,
    "definedPackages": [
      {}
    ]
  },
  "uncaughtExceptionHandler": {},
  "interrupted": true,
  "threadGroup": {
    "parent": {
      "parent": null,
      "name": null,
      "maxPriority": null,
      "destroyed": null,
      "daemon": null
    },
    "name": "string",
    "maxPriority": 0,
    "destroyed": true,
    "daemon": true
  },
  "stackTrace": [
    {
      "classLoaderName": "string",
      "moduleName": "string",
      "moduleVersion": "string",
      "methodName": "string",
      "fileName": "string",
      "lineNumber": 0,
      "className": "string",
      "nativeMethod": true
    }
  ],
  "alive": true,
  "id": 0,
  "state": "NEW"
}

Properties

Name Type Required Restrictions Description
name string false none none
priority integer(int32) false none none
daemon boolean false none none

ThreadGroup

{
  "parent": {
    "parent": {
      "parent": null,
      "name": null,
      "maxPriority": null,
      "destroyed": null,
      "daemon": null
    },
    "name": "string",
    "maxPriority": 0,
    "destroyed": true,
    "daemon": true
  },
  "name": "string",
  "maxPriority": 0,
  "destroyed": true,
  "daemon": true
}

Properties

None

TinyMCEEditorConfiguration

{
  "editorInstanceName": "string",
  "defaultCustomStyleMedia": "string",
  "extraHideIcons": "string",
  "enabledPlugins": [
    "string"
  ],
  "invalidElements": "string",
  "extendedValidElements": "string",
  "themeAdvancedBlockformats": "string",
  "menuCustomItems": "string",
  "toolbarCustomItems": "string",
  "customStyleEnabled": true,
  "hideIcons": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
editorInstanceName string false none none
defaultCustomStyleMedia string false none none
extraHideIcons string false none none
enabledPlugins [string] false none none
invalidElements string false none none
extendedValidElements string false none none
themeAdvancedBlockformats string false none none
menuCustomItems string false none none
toolbarCustomItems string false none none
customStyleEnabled boolean false none none
hideIcons [string] false none none

TinyMcePluginsDTO

{
  "fileNames": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
fileNames [string] false none none

TinyMceResponse

{}

Properties

None

TransferCredential

{
  "channels": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ]
}

Properties

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

TransferMetaData

{
  "id": 0,
  "name": "string",
  "description": "string",
  "remoteHost": "string",
  "remoteRoot": "string",
  "transferType": 0,
  "channelID": 0,
  "cleanServer": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) true none none
name string true none none
description string false none none
remoteHost string false none none
remoteRoot string false none none
transferType integer(int32) false none none
channelID integer(int32) false none none
cleanServer boolean false none none

TransferSiteDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "transferType": 0,
  "channelID": 0,
  "remoteRoot": "string",
  "remoteHost": "string",
  "remotePort": 0,
  "username": "string",
  "password": "string",
  "backupDir": "string",
  "uploadExtensionsToIgnore": [
    "string"
  ],
  "uploadDirectoriesToIgnore": [
    "string"
  ],
  "cleanExtensionsToIgnore": [
    "string"
  ],
  "cleanDirectoriesToIgnore": [
    "string"
  ],
  "encryptionLevel": 0,
  "ignoreSubDirInUploadEnabled": true,
  "passiveModeEnabled": true,
  "cleanUpServerEnabled": true,
  "ignoreSubDirInCleanUpEnabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
transferType integer(int32) false none none
channelID integer(int32) false none none
remoteRoot string false none none
remoteHost string false none none
remotePort integer(int32) false none none
username string false none none
password string false none none
backupDir string false none none
uploadExtensionsToIgnore [string] false none none
uploadDirectoriesToIgnore [string] false none none
cleanExtensionsToIgnore [string] false none none
cleanDirectoriesToIgnore [string] false none none
encryptionLevel integer(int32) false none none
ignoreSubDirInUploadEnabled boolean false none none
passiveModeEnabled boolean false none none
cleanUpServerEnabled boolean false none none
ignoreSubDirInCleanUpEnabled boolean false none none

TranslationDisclaimer

{
  "id": {
    "channel": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "languageCode": "string"
  },
  "disclaimer": "string"
}

Properties

None

TranslationDisclaimerDTO

{
  "channelID": 0,
  "languageCode": "string",
  "disclaimer": "string"
}

Properties

Name Type Required Restrictions Description
channelID integer(int32) false none none
languageCode string false none none
disclaimer string false none none

TranslationDisclaimerPK

{
  "channel": {
    "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": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "defaultLanguage": null,
      "rootSectionID": null,
      "fileOutputPath": null,
      "indexFileName": null,
      "baseHref": null,
      "siteRoot": null,
      "pathCaseModifier": null,
      "fullTextType": null,
      "fullTextExtension": null,
      "secondaryPublishLanguage": null,
      "channelPublishURL": null,
      "parent": null,
      "favIconID": null,
      "pollIconID": null,
      "accessControlConfigurationID": null,
      "personalisationConfigurationID": null,
      "publishReportLevel": null,
      "pendingVersionOutputPath": null,
      "pendingVersionBaseHref": null,
      "pendingVersionSiteRoot": null,
      "prePublishProcessorID": null,
      "allowScriptsInDirectEdit": null,
      "pxlFolder": null,
      "languages": null,
      "microSites": null,
      "permittedFileExtensions": null,
      "translationDisclaimers": null,
      "mediaPublishRules": null,
      "channelFullTextDisplayPeriod": null,
      "channelUsers": null,
      "channelContents": null,
      "mediaTypesWithPublishRuleCategory": null,
      "convertSpacesInSectionNameEnabled": null,
      "convertSpacesInRetainedFilenameEnabled": null,
      "channelCleanupEnabled": null,
      "personalisationEnabled": null,
      "accessControlEnabled": null,
      "fullTextDisplayPeriodValue": null,
      "fullTextDisplayPeriodUnit": null,
      "secondaryPublishEnabled": null,
      "overrideExtensionEnabled": null,
      "publishEmptySectionsEnabled": null,
      "convertSpacesInOutputURIEnabled": null,
      "parentID": null,
      "contentIDs": null,
      "languageCodes": null,
      "microSite": null
    },
    "favIconID": 0,
    "pollIconID": 0,
    "accessControlConfigurationID": 0,
    "personalisationConfigurationID": 0,
    "publishReportLevel": 0,
    "pendingVersionOutputPath": "string",
    "pendingVersionBaseHref": "string",
    "pendingVersionSiteRoot": "string",
    "prePublishProcessorID": 0,
    "allowScriptsInDirectEdit": 0,
    "pxlFolder": "string",
    "languages": [
      {}
    ],
    "microSites": [
      {}
    ],
    "permittedFileExtensions": [
      {}
    ],
    "translationDisclaimers": [
      {}
    ],
    "mediaPublishRules": [
      {}
    ],
    "channelFullTextDisplayPeriod": {
      "id": null,
      "enabled": null,
      "dateType": null,
      "filterType": null,
      "filter": null,
      "period": null,
      "periodUnit": null,
      "channel": null
    },
    "channelUsers": [
      {}
    ],
    "channelContents": [
      {}
    ],
    "mediaTypesWithPublishRuleCategory": [
      0
    ],
    "convertSpacesInSectionNameEnabled": true,
    "convertSpacesInRetainedFilenameEnabled": true,
    "channelCleanupEnabled": true,
    "personalisationEnabled": true,
    "accessControlEnabled": true,
    "fullTextDisplayPeriodValue": 0,
    "fullTextDisplayPeriodUnit": 0,
    "secondaryPublishEnabled": true,
    "overrideExtensionEnabled": true,
    "publishEmptySectionsEnabled": true,
    "convertSpacesInOutputURIEnabled": true,
    "parentID": 0,
    "contentIDs": [
      0
    ],
    "languageCodes": [
      "string"
    ],
    "microSite": true
  },
  "languageCode": "string"
}

Properties

None

Type

{
  "id": 0,
  "name": "string",
  "description": "string",
  "storageMethod": 0,
  "binary": true,
  "extensionChecking": true,
  "enabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
storageMethod integer(int32) false none none
binary boolean false none none
extensionChecking boolean false none none
enabled boolean false none none

TypeMetaDataDTO

{
  "id": 0,
  "name": "string",
  "listType": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
listType boolean false none none

UncaughtExceptionHandler

{}

Properties

None

User

{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "emailAddress": "string",
  "defaultLang": "string",
  "localeCountryCode": "string",
  "localeLanguageCode": "string",
  "localeVariant": "string",
  "createDate": "2019-08-24T14:15:22Z",
  "lastLoginDate": "2019-08-24T14:15:22Z",
  "enabled": true,
  "password": {
    "salt": "string",
    "hashedPassword": "string",
    "hashIterations": 0
  },
  "defaultPreviewChannel": 0,
  "preferredHtmlEditor": 0,
  "extranetConsent": true,
  "extranetAccess": "string",
  "extranetConsentDatetime": "2019-08-24T14:15:22Z",
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "children": [
        null
      ],
      "sections": [
        null
      ],
      "steps": [
        null
      ],
      "deleted": true,
      "memberCount": 0
    }
  ],
  "extensibleUserObjectContent": {
    "metaData": {
      "id": null,
      "contentTypeID": null,
      "archiveSection": null,
      "publishDate": null,
      "reviewDate": null,
      "expiryDate": null,
      "contentChannels": null,
      "contentVersions": null,
      "cloneSource": null,
      "sections": null,
      "channelIDs": null,
      "sectionIDs": null,
      "languages": null,
      "languageIndependant": null,
      "allLanguageMetaData": null,
      "languageCount": null
    },
    "elements": [
      {}
    ],
    "language": "string",
    "name": "string",
    "owner": 0,
    "id": 0,
    "version": {
      "version": null,
      "subMinor": null,
      "major": null,
      "minor": null
    },
    "lastModified": "2019-08-24T14:15:22Z",
    "status": 0,
    "sections": [
      {}
    ],
    "channelIDs": [
      0
    ],
    "contentTypeID": 0,
    "expiryDate": "2019-08-24T14:15:22Z",
    "sectionIDs": [
      0
    ],
    "archiveSection": 0,
    "reviewDate": "2019-08-24T14:15:22Z",
    "publishDate": "2019-08-24T14:15:22Z",
    "elementCount": 0,
    "lastModifiedBy": 0,
    "previousVersion": {
      "version": null,
      "subMinor": null,
      "major": null,
      "minor": null
    }
  },
  "sections": [
    {
      "id": 0,
      "level": 0,
      "status": 0,
      "printSequence": 0,
      "formSection": true,
      "archived": true,
      "users": [
        null
      ],
      "viewUsers": [
        null
      ],
      "groups": [
        null
      ],
      "viewGroups": [
        null
      ],
      "contentSections": [
        null
      ],
      "sectionInfos": {},
      "mirrorSections": [
        null
      ],
      "links": {},
      "rootChannels": [
        null
      ],
      "appliedPageLayouts": [
        null
      ],
      "hierarchyMirrorAcOpt": {},
      "hierarchyMirrorMetadataOpt": {},
      "children": [
        null
      ],
      "contentTypeScopes": [
        null
      ],
      "cloneSource": {},
      "sectionPaths": {},
      "sortLock": "[",
      "parent": {},
      "mirrors": [
        null
      ],
      "root": true,
      "shown": true,
      "nextSequence": 0,
      "entityID": 0,
      "childOfMirrored": true,
      "metadataOption": 0,
      "workflowID": 0,
      "childOfMirror": true,
      "workflowName": "string",
      "workflow": {},
      "channelRoot": [
        null
      ],
      "languages": [
        null
      ],
      "channels": [
        null
      ],
      "pathMembers": [
        null
      ],
      "sectionSortMethod": 0,
      "contentSortMethod": 0,
      "contentsAndSequences": {},
      "parentWorkflowID": 0,
      "inheritedPageLayouts": {},
      "currentOrInheritedWorkflow": 0,
      "contentNextSequence": 0,
      "accessControlOption": 0,
      "parentID": 0,
      "mirror": true,
      "allNames": {},
      "languageCount": 0,
      "mirrorSource": {},
      "link": true,
      "mirrorSourceID": 0
    }
  ],
  "userChannels": [
    {
      "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": {},
      "favIconID": 0,
      "pollIconID": 0,
      "accessControlConfigurationID": 0,
      "personalisationConfigurationID": 0,
      "publishReportLevel": 0,
      "pendingVersionOutputPath": "string",
      "pendingVersionBaseHref": "string",
      "pendingVersionSiteRoot": "string",
      "prePublishProcessorID": 0,
      "allowScriptsInDirectEdit": 0,
      "pxlFolder": "string",
      "languages": [
        null
      ],
      "microSites": [
        null
      ],
      "permittedFileExtensions": [
        null
      ],
      "translationDisclaimers": [
        null
      ],
      "mediaPublishRules": [
        null
      ],
      "channelFullTextDisplayPeriod": {},
      "channelUsers": [
        null
      ],
      "channelContents": [
        null
      ],
      "mediaTypesWithPublishRuleCategory": [
        null
      ],
      "convertSpacesInSectionNameEnabled": true,
      "convertSpacesInRetainedFilenameEnabled": true,
      "channelCleanupEnabled": true,
      "personalisationEnabled": true,
      "accessControlEnabled": true,
      "fullTextDisplayPeriodValue": 0,
      "fullTextDisplayPeriodUnit": 0,
      "secondaryPublishEnabled": true,
      "overrideExtensionEnabled": true,
      "publishEmptySectionsEnabled": true,
      "convertSpacesInOutputURIEnabled": true,
      "parentID": 0,
      "contentIDs": [
        null
      ],
      "languageCodes": [
        null
      ],
      "microSite": true
    }
  ],
  "locale": {
    "language": "string",
    "displayName": "string",
    "script": "string",
    "country": "string",
    "variant": "string",
    "extensionKeys": [
      "string"
    ],
    "unicodeLocaleAttributes": [
      "string"
    ],
    "unicodeLocaleKeys": [
      "string"
    ],
    "iso3Language": "string",
    "iso3Country": "string",
    "displayLanguage": "string",
    "displayScript": "string",
    "displayCountry": "string",
    "displayVariant": "string"
  },
  "fullName": "string",
  "deleted": true,
  "powerUser": true,
  "administrator": true,
  "authLevel": 0,
  "fullTinyMCELocaleCode": "string",
  "appliedPreviewChannel": 0,
  "propertyResourceBundle": {
    "locale": {
      "language": null,
      "displayName": null,
      "script": null,
      "country": null,
      "variant": null,
      "extensionKeys": null,
      "unicodeLocaleAttributes": null,
      "unicodeLocaleKeys": null,
      "iso3Language": null,
      "iso3Country": null,
      "displayLanguage": null,
      "displayScript": null,
      "displayCountry": null,
      "displayVariant": null
    },
    "keys": {},
    "baseBundleName": "string"
  },
  "fullLocaleCode": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
username string false none none
firstName string false none none
lastName string false none none
emailAddress string false none none
defaultLang string false none none
localeCountryCode string false none none
localeLanguageCode string false none none
localeVariant string false none none
createDate string(date-time) false none none
lastLoginDate string(date-time) false none none
enabled boolean false none none

UserCredentialsDTO

{
  "authLevelEnabled": [
    {
      "authLevelDescription": "string",
      "authLevelId": 0,
      "accessRightsEnabled": true,
      "modifyEnabled": true,
      "eraseEnabled": true
    }
  ],
  "groupsAllowed": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "availableLocales": [
    {
      "id": "string",
      "description": "string",
      "localeLanguageCode": "string",
      "localeCountryCode": "string",
      "localeVariant": "string",
      "defaultLocale": true
    }
  ],
  "htmlEditors": [
    {
      "id": 0,
      "name": "string",
      "minimumAccessLevel": 0,
      "defaultEditor": true
    }
  ],
  "extranetAccessList": [
    {
      "value": "string",
      "description": "string",
      "defaultAccessLevel": true
    }
  ],
  "channels": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ],
  "authMethods": [
    {
      "id": 0,
      "name": "string",
      "identifier": "string",
      "enabled": true
    }
  ],
  "channelsSelect": [
    {
      "id": 0,
      "description": "string",
      "name": "string",
      "parentID": 0,
      "fullName": "string"
    }
  ],
  "userExtensibleObjectID": 0,
  "contentExtensibleUserObjectID": 0,
  "canAssignChannelsToModeratorsEnabled": true,
  "canDeleteUsersEnabled": true,
  "canAssignChannelsEnabled": true,
  "createNewUserEnabled": true,
  "canAddToOwngroupEnabled": true,
  "readOnlyAuthMethodsEnabled": true,
  "editUsersEnabled": true
}

Properties

Name Type Required Restrictions Description
authLevelEnabled [UserLevelDTO] false none none

UserDTO

{
  "id": 0,
  "userLevel": 0,
  "defaultPreviewChannel": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "userInterfaceLanguageId": "string",
  "password": "string",
  "extranetAccess": "string",
  "enabled": true,
  "htmlEditor": 0,
  "membershipGroups": 0,
  "groupUser": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0
    }
  ],
  "assignedChannelsList": [
    0
  ],
  "authenticationMappingList": [
    {
      "id": 0,
      "name": "string",
      "identifier": "string",
      "enabled": true
    }
  ],
  "userSectionDto": [
    {
      "id": 0,
      "path": "string",
      "parentID": 0,
      "group": true,
      "user": true,
      "media": true
    }
  ],
  "userExtensibleObjectDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  },
  "canModifyExtranetConsentEnabled": true,
  "extranetConsentEnabled": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
userLevel integer(int32) false none none
defaultPreviewChannel integer(int32) false none none
username string false none none
firstName string false none none
lastName string false none none
emailAddress string false none none
defaultLanguage string false none none
userInterfaceLanguageId string false none none
password string false none none
extranetAccess string false none none
enabled boolean false none none
htmlEditor integer(int32) false none none
membershipGroups integer(int32) false none none
groupUser [GroupDTO] false none none

UserGroupDTO

{
  "users": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
users [UserMetaDataDTO] false none none

UserLevelDTO

{
  "authLevelDescription": "string",
  "authLevelId": 0,
  "accessRightsEnabled": true,
  "modifyEnabled": true,
  "eraseEnabled": true
}

Properties

Name Type Required Restrictions Description
authLevelDescription string false none none
authLevelId integer(int32) false none none
accessRightsEnabled boolean false none none
modifyEnabled boolean false none none
eraseEnabled boolean false none none

UserMetaData

{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "emailAddress": "string",
  "defaultLang": "string",
  "enabled": true,
  "deleted": true,
  "authLevel": 0
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
username string false none none
firstName string false none none
lastName string false none none
emailAddress string false none none
defaultLang string false none none
enabled boolean false none none
deleted boolean false none none
authLevel integer(int32) false none none

UserMetaDataDTO

{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "authLevel": 0,
  "emailAddress": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
username string false none none
firstName string false none none
lastName string false none none
authLevel integer(int32) false none none
emailAddress string false none none

UserProfileView

{
  "firstName": "string",
  "lastName": "string",
  "username": "string",
  "emailAddress": "string",
  "defaultLanguage": "string",
  "oldPassword": "string",
  "newPassword": "string",
  "newPasswordConfirm": "string",
  "uiLocale": "string",
  "htmlEditorId": 0,
  "defaultPreviewChannelId": 0,
  "userLevel": 0,
  "contentId": 0,
  "contentDto": {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-08-24T14:15:22Z",
    "reviewDate": "2019-08-24T14:15:22Z",
    "expiryDate": "2019-08-24T14:15:22Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {}
    ],
    "status": 0,
    "lastModified": "2019-08-24T14:15:22Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": null,
      "type": null
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "contentTypeAccess": 0,
    "contentTypeLock": {
      "assetID": null,
      "assetType": null,
      "lockType": null,
      "expiry": null,
      "owner": null,
      "ownerName": null,
      "currentUser": null,
      "language": null
    },
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": null,
      "name": null,
      "description": null,
      "type": null,
      "editable": null,
      "primaryGroup": null,
      "sharedGroups": null,
      "alias": null,
      "workflow": null,
      "systemTemplate": null,
      "sharedGroupCount": null,
      "contentTypeElements": null,
      "metaMapped": null,
      "lock": null,
      "minAuthLevel": null,
      "enableDirectEdit": null,
      "elementIdforFilename": null,
      "warningMessage": null,
      "sectionId": null,
      "duplicate": null,
      "duplicatedFromId": null,
      "fullyAccessible": null
    },
    "types": [
      {}
    ],
    "insertAtIndex": 0,
    "sortLock": "TOP",
    "excludedMirrorSectionIds": [
      0
    ],
    "locked": true,
    "sectionIDs": [
      0
    ]
  }
}

Properties

Name Type Required Restrictions Description
firstName string false none none
lastName string false none none
username string false none none
emailAddress string false none none
defaultLanguage string false none none
oldPassword string false none none
newPassword string false none none
newPasswordConfirm string false none none
uiLocale string false none none
htmlEditorId integer(int32) false none none
defaultPreviewChannelId integer(int32) false none none
userLevel integer(int32) false none none
contentId integer(int32) false none none

UserSearchDTO

{
  "userList": [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "authLevel": 0,
      "emailAddress": "string"
    }
  ],
  "overLimit": true
}

Properties

Name Type Required Restrictions Description
userList [UserMetaDataDTO] false none none

UserSectionDTO

{
  "id": 0,
  "path": "string",
  "parentID": 0,
  "group": true,
  "user": true,
  "media": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
path string false none none
parentID integer(int32) false none none
group boolean false none none
user boolean false none none
media boolean false none none

ValidatedInfo

{
  "licencee": {
    "companyName": "string",
    "registeredOffice": "string",
    "territory": "string",
    "companyStatus": "string"
  },
  "licenceContact": {
    "salutation": "string",
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "legalSalutation": "string",
    "legalFirstname": "string",
    "legalLastname": "string"
  },
  "partnerDetails": {
    "name": "string",
    "partnerSalutation": "string",
    "partnerFirstname": "string",
    "partnerLastname": "string"
  },
  "licenceDetails": {
    "productLicenced": "string",
    "begins": "2019-08-24T14:15:22Z",
    "ends": "2019-08-24T14:15:22Z",
    "hostname": "string"
  },
  "restrictions": {
    "content": "string",
    "user": "string",
    "channel": "string",
    "workflow": "string",
    "contentType": "string",
    "language": "string"
  }
}

Properties

None

VariantDTO

{
  "id": 0,
  "language": "string",
  "name": "string",
  "description": "string",
  "parentID": 0,
  "type": 0,
  "thumbnailURL": "string",
  "dimensions": [
    0
  ],
  "variantName": "string",
  "variantDimensions": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
language string false none none
name string false none none
description string false none none
parentID integer(int32) false none none
type integer(int32) false none none
thumbnailURL string false none none
dimensions [integer] false none none
variantName string false none none
variantDimensions string false none none

Version

{
  "version": "string",
  "subMinor": 0,
  "major": 0,
  "minor": 0
}

Properties

Name Type Required Restrictions Description
version string false none none
subMinor integer(int32) false none none
major integer(int32) false none none
minor integer(int32) false none none

WorkflowCredentialsDTO

{
  "listWorkflowGroup": [
    {
      "workflowMetaDataDTO": {},
      "groupName": "string",
      "id": 0,
      "canPerformActionsEnabled": true,
      "canCreateNewEnabled": true,
      "global": true
    }
  ],
  "groupAllowed": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "membersCount": 0,
      "groupSections": [
        null
      ],
      "members": [
        null
      ],
      "defaultPreviewChannel": 0,
      "emailAddress": "string",
      "children": [
        null
      ],
      "groupChildren": [
        null
      ],
      "ldap": true,
      "groupEnabled": true
    }
  ],
  "canCreateOnlyGroupAsset": true,
  "approvers": {
    "users": [
      {}
    ],
    "groups": [
      {}
    ]
  },
  "canCreateNewWorkflowEnabled": true
}

Properties

Name Type Required Restrictions Description
listWorkflowGroup [WorkflowGroupDTO] false none none

WorkflowEntity

{
  "id": 0,
  "name": "string",
  "description": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "lastModified": "2019-08-24T14:15:22Z",
  "contentTypes": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "warningMessage": "string",
      "elements": [
        null
      ],
      "elementForFilename": 0,
      "alias": "string",
      "directEditEnabled": true,
      "workflow": {},
      "duplicate": true,
      "type": 0,
      "sectionID": 0,
      "minAuthLevel": 0
    }
  ],
  "section": [
    {
      "id": 0,
      "level": 0,
      "status": 0,
      "printSequence": 0,
      "formSection": true,
      "archived": true,
      "users": [
        null
      ],
      "viewUsers": [
        null
      ],
      "groups": [
        null
      ],
      "viewGroups": [
        null
      ],
      "contentSections": [
        null
      ],
      "sectionInfos": {},
      "mirrorSections": [
        null
      ],
      "links": {},
      "rootChannels": [
        null
      ],
      "appliedPageLayouts": [
        null
      ],
      "hierarchyMirrorAcOpt": {},
      "hierarchyMirrorMetadataOpt": {},
      "children": [
        null
      ],
      "contentTypeScopes": [
        null
      ],
      "cloneSource": {},
      "sectionPaths": {},
      "sortLock": "[",
      "parent": {},
      "mirrors": [
        null
      ],
      "root": true,
      "shown": true,
      "nextSequence": 0,
      "entityID": 0,
      "childOfMirrored": true,
      "metadataOption": 0,
      "workflowID": 0,
      "childOfMirror": true,
      "workflowName": "string",
      "workflow": {},
      "channelRoot": [
        null
      ],
      "languages": [
        null
      ],
      "channels": [
        null
      ],
      "pathMembers": [
        null
      ],
      "sectionSortMethod": 0,
      "contentSortMethod": 0,
      "contentsAndSequences": {},
      "parentWorkflowID": 0,
      "inheritedPageLayouts": {},
      "currentOrInheritedWorkflow": 0,
      "contentNextSequence": 0,
      "accessControlOption": 0,
      "parentID": 0,
      "mirror": true,
      "allNames": {},
      "languageCount": 0,
      "mirrorSource": {},
      "link": true,
      "mirrorSourceID": 0
    }
  ],
  "workflowSteps": [
    {
      "workflowEntity": {},
      "stepEntity": {},
      "sequence": 0
    }
  ],
  "restricted": true,
  "firstStep": {
    "id": 0,
    "name": "string",
    "description": "string",
    "lastModified": "2019-08-24T14:15:22Z",
    "priority": "PRIORITY_LOWEST",
    "restrictToEditors": 0,
    "language": {
      "code": null,
      "name": null,
      "charset": null,
      "disclaimer": null,
      "channels": null
    },
    "users": [
      {}
    ],
    "groups": [
      {}
    ],
    "options": {
      "id": null,
      "stepEntity": null,
      "rejectType": null,
      "rejectStep": null,
      "voteType": null,
      "voteModerator": null,
      "stepHour": null,
      "stepDay": null,
      "languageType": null,
      "languageNumber": null,
      "alertUser": null,
      "alertMode": null,
      "alertTypes": null
    },
    "workflowSteps": [
      {}
    ]
  }
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
creationDate string(date-time) false none none
lastModified string(date-time) false none none
contentTypes [ContentType] false none none

WorkflowEntityDTO

{
  "id": 0,
  "name": "string",
  "description": "string",
  "groupAssetID": 0,
  "restricted": true
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none
groupAssetID integer(int32) false none none
restricted boolean false none none

WorkflowGroupDTO

{
  "workflowMetaDataDTO": {
    "id": 0,
    "name": "string",
    "description": "string"
  },
  "groupName": "string",
  "id": 0,
  "canPerformActionsEnabled": true,
  "canCreateNewEnabled": true,
  "global": true
}

Properties

None

WorkflowMetaDataDTO

{
  "id": 0,
  "name": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
description string false none none

WorkflowStepEntity

{
  "workflowEntity": {
    "id": 0,
    "name": "string",
    "description": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "contentTypes": [
      {}
    ],
    "section": [
      {}
    ],
    "workflowSteps": [
      {}
    ],
    "restricted": true,
    "firstStep": {
      "id": null,
      "name": null,
      "description": null,
      "lastModified": null,
      "priority": null,
      "restrictToEditors": null,
      "language": null,
      "users": null,
      "groups": null,
      "options": null,
      "workflowSteps": null
    }
  },
  "stepEntity": {
    "id": 0,
    "name": "string",
    "description": "string",
    "lastModified": "2019-08-24T14:15:22Z",
    "priority": "PRIORITY_LOWEST",
    "restrictToEditors": 0,
    "language": {
      "code": null,
      "name": null,
      "charset": null,
      "disclaimer": null,
      "channels": null
    },
    "users": [
      {}
    ],
    "groups": [
      {}
    ],
    "options": {
      "id": null,
      "stepEntity": null,
      "rejectType": null,
      "rejectStep": null,
      "voteType": null,
      "voteModerator": null,
      "stepHour": null,
      "stepDay": null,
      "languageType": null,
      "languageNumber": null,
      "alertUser": null,
      "alertMode": null,
      "alertTypes": null
    },
    "workflowSteps": [
      {}
    ]
  },
  "sequence": 0
}

Properties

None

Writer

{}

Properties

None

Shell HTTP JavaScript Ruby Python PHP Java Go