Cobalt API references

The Site APIs offer programmatic access to sites contents. The API offers to developers the ability to read the site map, the contents and stories published on the site, and more. Responses are available in JSON.

OVERVIEW

The Site APIs is a way to get data in and out of Cobalt platform. It’s a low-level HTTP/JSON based API that you can use to query data in the site and build custom applications (e.g. mobile apps) on top of a site.

USING THE REST APIS

The Site APIs are accessible from the "/api" path of your site and include the endpoints:

  • "/cache" to manage ContentData, NodeData and Generic caches,

  • "/nodes" to retrieve information about the site’s published nodes, including both content and hierarchical nodes,

  • "/pages" to retrieve aggregate pages,

  • "/publications" to access site publication data,

  • "/search" to query published content through powerful free text search,

  • "/site" to retrieve information about the site structure, its section and specific data of each site node,

  • "/themes" to list the themes available for your site,

  • "/urls" to eval urls for contents or, the other way around, resolve contents from their url.

The site module is capable of serving multiple sites on a single installation. Some of the APIs are dependent on the hostname (and the site) on the request uri, some others, such as the "themes" API are site independent.

ERRORS

Site not found

Code Description

404

You requested a site dependent API from a non existing site’s hostname

{
    "error": {
        "message": "Site not found for base uri 'http://localhost:8080'",
        "type": "ENTITY_NOT_FOUND"
    }
}

Section not found

Code Description

404

The requested section path does not exists.

{
    "error": {
        "message": "Section not found",
        "type": "ENTITY_NOT_FOUND"
    }
}

Nodes

v.3.2019.05.p2

Methods to retrieve information about the site’s published nodes, including both content and hierarchical nodes.

API

GET

/nodes

List all nodes published on a site or section.

GET

/nodes/{id}

Retrieve node information by ID.

GET

/nodes/{id}/files/{file}

Redirect to the url serving the requested node file content stream.

GET

/nodes/{id}/files/{file}/metadata

Retrieve node file information.

GET

/nodes/{id}/versions/live

List the history of live versions of the requested node.

GET

/nodes/foreignid/{foreignId}

Retrieve node information by its foreign id.

Read File - /nodes/{id}/files/{file}/metadata

v.3.2019.05.p2

Retrieve node file information.

File can be retrieved from both content and hierarchical node. Require the name (a.k.a. format) of the file.

RESOURCE URL

GET /nodes/{id}/files/{file}/metadata

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

PATH PARAMETERS

Parameter Required Default Description

file String

Yes

-

id NodeId

Yes

Node ID

REQUEST

example

GET /api/nodes/022f-0455cc697fbb-16bf8de3505e-0004/files/content/metadata HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "fileName" : "content.xml",
  "mimeType" : "text/xml",
  "updatedBy" : {
    "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
    "userName" : "matteo"
  },
  "updateTime" : "2016-07-06T14:04:25.980Z",
  "size" : 4007,
  "data" : "..."
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the node or the file do not exist.

Read Node - /nodes/{id}

v.3.2019.05.p2

Retrieve node information by ID.

Include both hierarchy nodes and content nodes.

RESOURCE URL

GET /nodes/{id}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

aggregator SortedSet

Yes

-

PATH PARAMETERS

Parameter Required Default Description

id NodeId

Yes

Node id

REQUEST

example

GET /api/nodes/022f-0455cc697fbb-16bf8de3505e-0004 HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "id" : "022f-0455cc697fbb-16bf8de3505e-0004",
  "version" : "022f-0455cc697fbb-16bf8de3505e-0004-47743466261",
  "timestamp" : "2016-07-06T14:04:26.261Z",
  "foreignId" : "8965fbb4-42cc-11e6-8397-58a7d6f7e45e",
  "title" : "Ned Stark’s Death",
  "description" : "",
  "summary" : "The Death of Ned",
  "sys" : {
    "kind" : "content",
    "baseType" : "article",
    "type" : "article",
    "creationTime" : "2016-07-05T16:24:42.251Z",
    "createdBy" : {
      "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
      "userName" : "matteo"
    },
    "updateTime" : "2016-07-06T14:04:26.261Z",
    "updatedBy" : {
      "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
      "userName" : "matteo"
    }
  },
  "pubInfo" : {
    "siteName" : "game-of-thrones",
    "status" : "LIVE",
    "publicationTime" : "2016-07-06T14:04:26.261Z",
    "publishedBy" : {
      "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
      "userName" : "matteo"
    },
    "attributes" : {
      "pubDate" : "2016-07-06T14:04:25.592Z",
      "lastModified" : "2016-07-05T21:50:04.000Z",
      "sha1Content" : "kNXz0fqhoU15/CRsCQs5qKgSz+o",
      "primary" : true,
      "agent" : "cobaltpub",
      "path" : "/Cobalt/game-of-thrones/Stories/season-1/Ned Stark's Death.xml",
      "eomDbid" : "199",
      "publicationId" : "3228e45e-5745-412c-b521-2a63be224150"
    },
    "sectionPath" : "/season-1/"
  },
  "attributes" : {
    "tags" : [ "GameOfThrones", "war", "حدوث", "à" ],
    "tags" : [ "GameOfThrones", "war", "حدوث", "à" ]
  },
  "files" : {
    "content" : {
      "fileName" : "content.xml",
      "mimeType" : "text/xml",
      "updatedBy" : {
        "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
        "userName" : "matteo"
      },
      "updateTime" : "2016-07-06T14:04:25.980Z",
      "size" : 4007,
      "data" : "..."
    }
  },
  "links" : {
    "hyperlink" : {
      "image" : [ {
        "targetId" : "022f-0455cc697fe4-dd009fb432f0-0004-47743466261",
        "key" : 1537228672809128960,
        "maxItems" : 0
      }, {
        "targetId" : "022f-0457841d4f6c-5a49343db2ff-0004-47743466261",
        "key" : 2767011611056432640,
        "maxItems" : 0
      }, {
        "targetId" : "022f-04579d3ad2f0-5855aa05ef58-0004-47743466261",
        "key" : 3504881374004814720,
        "maxItems" : 0
      } ]
    }
  },
  "pubInfoEx" : {
    "game-of-thrones" : {
      "siteName" : "game-of-thrones",
      "status" : "LIVE",
      "publicationTime" : "2016-07-06T14:04:26.037Z",
      "publishedBy" : {
        "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
        "userName" : "matteo"
      },
      "attributes" : {
        "pubDate" : "2016-07-06T14:04:25.592Z",
        "lastModified" : "2016-07-05T21:50:04.000Z",
        "sha1Content" : "kNXz0fqhoU15/CRsCQs5qKgSz+o",
        "primary" : true,
        "agent" : "cobaltpub",
        "path" : "/Cobalt/game-of-thrones/Stories/season-1/Ned Stark's Death.xml",
        "eomDbid" : "199",
        "publicationId" : "3228e45e-5745-412c-b521-2a63be224150"
      },
      "liveInfo" : {
        "version" : "022f-0455cc697fbb-16bf8de3505e-0004-47743466261",
        "sourceVersion" : "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
        "publicationTime" : "2016-07-06T14:04:26.261Z",
        "publishedBy" : {
          "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName" : "matteo"
        }
      },
      "stageInfo" : {
        "version" : "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
        "publicationTime" : "2016-07-06T14:04:26.037Z",
        "publishedBy" : {
          "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName" : "matteo"
        }
      },
      "previewInfo" : {
        "version" : "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
        "publishedBy" : {
          "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName" : "matteo"
        }
      },
      "sectionPath" : "/season-1/"
    }
  },
  "contentLength" : 0,
  "cacheKey" : "022f-0455cc697fbb-16bf8de3505e-0004",
  "lastModified" : 0,
  "cacheTimestamp" : 0,
  "dataType" : "node"
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the node does not exists.

List live versions - /nodes/{id}/versions/live

v.3.2019.05.p2

List the history of live versions of the requested node.

The user must have write permission on the requested node family.

RESOURCE URL

GET /nodes/{id}/versions/live

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

oldestFirst Boolean

No

false

Put oldest version on top

PATH PARAMETERS

Parameter Required Default Description

id NodeId

Yes

Node family id

REQUEST

example

GET /api/nodes/022f-0455cc697fbb-16bf8de3505e-0004/versions/live HTTP/1.1
Host: site.dev

example with oldest first

GET /api/nodes/022f-0455cc697fbb-16bf8de3505e-0004/versions/live?oldestFirst=true HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "count" : 4,
  "result" : [ {
    "title" : "life-dwp.dwp",
    "type" : "webpage",
    "versionTimestamp" : 109344856998,
    "versionDate" : "2018-06-19T13:34:16.998Z",
    "nodeId" : "0243-094f20b24418-5a4e5c5ada05-1000-109344856998",
    "major" : 5,
    "minor" : 0,
    "pubInfo" : {
      "siteName" : "the-globe",
      "status" : "LIVE",
      "publicationTime" : "2018-06-19T13:34:16.998Z",
      "attributes" : {
        "pubDate" : "2018-06-19T13:34:00.614Z",
        "lastModified" : "2018-03-21T20:24:53.000Z",
        "sha1DwxLinks" : "k+3GG3N56RUyJg2ig+erHoXQmPU",
        "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
        "primary" : true,
        "agent" : "cobaltpub",
        "path" : "/Cobalt/the-globe/WebPages/life/life-dwp.dwp",
        "eomDbid" : "199",
        "publicationId" : "360878b7-1581-482e-a491-10249c75e8be"
      },
      "sectionPath" : "/news/",
      "visible" : true
    }
  }, {
    "title" : "life-dwp.dwp",
    "type" : "webpage",
    "versionTimestamp" : 109344731031,
    "versionDate" : "2018-06-19T13:32:11.031Z",
    "nodeId" : "0243-094f20b24418-5a4e5c5ada05-1000-109344731031",
    "major" : 4,
    "minor" : 0,
    "pubInfo" : {
      "siteName" : "the-globe",
      "status" : "LIVE",
      "publicationTime" : "2018-06-19T13:32:11.031Z",
      "attributes" : {
        "pubDate" : "2018-06-19T13:31:19.497Z",
        "lastModified" : "2018-03-21T20:24:53.000Z",
        "sha1DwxLinks" : "k+3GG3N56RUyJg2ig+erHoXQmPU",
        "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
        "primary" : true,
        "agent" : "cobaltpub",
        "path" : "/Cobalt/the-globe/WebPages/life/life-dwp.dwp",
        "eomDbid" : "199",
        "publicationId" : "2be2cf03-1c32-4e35-a25b-ed960cf770c5"
      },
      "sectionPath" : "/life/",
      "visible" : true
    }
  }, {
    "title" : "life-dwp.dwp",
    "type" : "webpage",
    "versionTimestamp" : 108834348854,
    "versionDate" : "2018-06-13T15:45:48.854Z",
    "nodeId" : "0243-094f20b24418-5a4e5c5ada05-1000-108834348854",
    "major" : 2,
    "minor" : 0,
    "pubInfo" : {
      "siteName" : "the-globe",
      "status" : "LIVE",
      "publicationTime" : "2018-06-13T15:45:48.854Z",
      "attributes" : {
        "pubDate" : "2018-06-13T15:45:48.423Z",
        "lastModified" : "2018-03-21T20:24:53.000Z",
        "sha1DwxLinks" : "k+3GG3N56RUyJg2ig+erHoXQmPU",
        "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
        "primary" : true,
        "agent" : "cobaltpub",
        "path" : "/Cobalt/the-globe/WebPages/life/life-dwp.dwp",
        "eomDbid" : "199",
        "publicationId" : "8971e290-db3e-4477-9d8a-338b90c0c5b8"
      },
      "sectionPath" : "/life/",
      "visible" : true
    }
  }, {
    "title" : "life-dwp.dwp",
    "type" : "webpage",
    "versionTimestamp" : 108833946410,
    "versionDate" : "2018-06-13T15:39:06.410Z",
    "nodeId" : "0243-094f20b24418-5a4e5c5ada05-1000-108833946410",
    "major" : 1,
    "minor" : 0,
    "pubInfo" : {
      "siteName" : "the-globe",
      "status" : "LIVE",
      "publicationTime" : "2018-06-13T15:39:06.410Z",
      "attributes" : {
        "pubDate" : "2018-06-13T15:38:52.968Z",
        "lastModified" : "2018-03-21T20:24:53.000Z",
        "sha1DwxLinks" : "t8WJlB2PKQx0N3iaEPwROTSpOxA",
        "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
        "primary" : true,
        "agent" : "cobaltpub",
        "path" : "/Cobalt/the-globe/WebPages/life/life-dwp.dwp",
        "eomDbid" : "199",
        "publicationId" : "4aa07abe-5641-4883-8dff-b397f8721df5"
      },
      "sectionPath" : "/life/",
      "visible" : true
    }
  } ]
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the node family does not exist.

List Nodes - /nodes

v.3.2019.05.p2

List all nodes published on a site or section.

Include both hierarchy nodes and content nodes and allows to filter by tags, base type of the node.

The "tag" parameter filter nodes containing the requested tags in the default tag family. To search a different tag family you can use as many "tag.<family>" parameters as you need.

RESOURCE URL

GET /nodes

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

aggregator SortedSet

No

Aggregators list

author String

No

Nodes author

count Boolean

No

true

Add the total count of the results

limit int

No

20

Page limit

offset int

No

0

Page offset

recursive Boolean

No

false

Search recursively in nested sections

section String

No

/

Section path (slash separated section’s name from the root)

sectionId NodeId

No

Section ID

sortBy SortBy

No

DATE

Order of the results

tag List

No

Nodes tags (Use "tag.<family>" as parameter if you want to search in a different family)

type List

No

Nodes base type

REQUEST

example - filtering by section and type

GET /api/nodes?section=/season-1/&type=article HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "count": 1,
  "result": [
    {
      "id": "022f-0455cc697fbb-16bf8de3505e-0004",
      "version": "022f-0455cc697fbb-16bf8de3505e-0004-47743466261",
      "timestamp": "2016-07-06T14:04:26.261Z",
      "foreignId": "8965fbb4-42cc-11e6-8397-58a7d6f7e45e",
      "title": "Ned Stark’s Death",
      "description": "",
      "summary": "The Death of Ned",
      "sys": {
        "kind": "content",
        "baseType": "article",
        "type": "article",
        "creationTime": "2016-07-05T16:24:42.251Z",
        "createdBy": {
          "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName": "matteo"
        },
        "updateTime": "2016-07-06T14:04:26.261Z",
        "updatedBy": {
          "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName": "matteo"
        }
      },
      "pubInfo": {
        "siteName": "game-of-thrones",
        "status": "LIVE",
        "publicationTime": "2016-07-06T14:04:26.261Z",
        "publishedBy": {
          "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName": "matteo"
        },
        "attributes": {
          "pubDate": "2016-07-06T14:04:25.592Z",
          "lastModified": "2016-07-05T21:50:04.000Z",
          "sha1Content": "kNXz0fqhoU15/CRsCQs5qKgSz+o",
          "primary": true,
          "agent": "cobaltpub",
          "path": "/Cobalt/game-of-thrones/Stories/season-1/Ned Stark's Death.xml",
          "eomDbid": "199",
          "publicationId": "3228e45e-5745-412c-b521-2a63be224150"
        },
        "sectionPath": "/season-1/"
      },
      "attributes": {
        "tags": [
          "GameOfThrones",
          "war",
          "حدوث",
          "à"
        ]
      },
      "files": {
        "content": {
          "fileName": "content.xml",
          "mimeType": "text/xml",
          "updatedBy": {
            "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
            "userName": "matteo"
          },
          "updateTime": "2016-07-06T14:04:25.980Z",
          "size": 4007,
          "data" : "..."
        }
      },
      "links": {
        "hyperlink": {
          "image": [
            {
              "targetId": "022f-0455cc697fe4-dd009fb432f0-0004-47743466261",
              "key": 1537228672809128960,
              "maxItems": 0
            },
            {
              "targetId": "022f-0457841d4f6c-5a49343db2ff-0004-47743466261",
              "key": 2767011611056432640,
              "maxItems": 0
            },
            {
              "targetId": "022f-04579d3ad2f0-5855aa05ef58-0004-47743466261",
              "key": 3504881374004814720,
              "maxItems": 0
            }
          ]
        }
      },
      "pubInfoEx": {
        "game-of-thrones": {
          "siteName": "game-of-thrones",
          "status": "LIVE",
          "publicationTime": "2016-07-06T14:04:26.037Z",
          "publishedBy": {
            "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
            "userName": "matteo"
          },
          "attributes": {
            "pubDate": "2016-07-06T14:04:25.592Z",
            "lastModified": "2016-07-05T21:50:04.000Z",
            "sha1Content": "kNXz0fqhoU15/CRsCQs5qKgSz+o",
            "primary": true,
            "agent": "cobaltpub",
            "path": "/Cobalt/game-of-thrones/Stories/season-1/Ned Stark's Death.xml",
            "eomDbid": "199",
            "publicationId": "3228e45e-5745-412c-b521-2a63be224150"
          },
          "liveInfo": {
            "version": "022f-0455cc697fbb-16bf8de3505e-0004-47743466261",
            "sourceVersion": "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
            "publicationTime": "2016-07-06T14:04:26.261Z",
            "publishedBy": {
              "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
              "userName": "matteo"
            }
          },
          "stageInfo": {
            "version": "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
            "publicationTime": "2016-07-06T14:04:26.037Z",
            "publishedBy": {
              "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
              "userName": "matteo"
            }
          },
          "previewInfo": {
            "version": "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
            "publishedBy": {
              "userId": "323dc672-e3f0-4549-8d9a-5e45d5464028",
              "userName": "matteo"
            }
          },
          "sectionPath": "/season-1/"
        }
      },
      "contentLength": 0,
      "cacheKey": "022f-0455cc697fbb-16bf8de3505e-0004",
      "lastModified": 0,
      "cacheTimestamp": 0,
      "dataType": "node"
    }
  ],
  "limit": 20,
  "offset": 0
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if no section correspond to the requested section path.

Read Node by Foreign Id - /nodes/foreignid/{foreignId}

v.3.2019.05.p2

Retrieve node information by its foreign id.

Include both hierarchy nodes and content nodes.

RESOURCE URL

GET /nodes/foreignid/{foreignId}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

aggregator SortedSet

Yes

-

PATH PARAMETERS

Parameter Required Default Description

foreignId String

Yes

String foreignId

REQUEST

example

GET /api/nodes/foreignid/fe3d7bf0-cf10-4f8e-9a7e-dfed63775ca4 HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "id" : "022f-0455cc697fbb-16bf8de3505e-0004",
  "version" : "022f-0455cc697fbb-16bf8de3505e-0004-47743466261",
  "timestamp" : "2016-07-06T14:04:26.261Z",
  "foreignId" : "fe3d7bf0-cf10-4f8e-9a7e-dfed63775ca4",
  "title" : "Ned Stark’s Death",
  "description" : "",
  "summary" : "The Death of Ned",
  "sys" : {
    "kind" : "content",
    "baseType" : "article",
    "type" : "article",
    "creationTime" : "2016-07-05T16:24:42.251Z",
    "createdBy" : {
      "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
      "userName" : "matteo"
    },
    "updateTime" : "2016-07-06T14:04:26.261Z",
    "updatedBy" : {
      "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
      "userName" : "matteo"
    }
  },
  "pubInfo" : {
    "siteName" : "game-of-thrones",
    "status" : "LIVE",
    "publicationTime" : "2016-07-06T14:04:26.261Z",
    "publishedBy" : {
      "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
      "userName" : "matteo"
    },
    "attributes" : {
      "pubDate" : "2016-07-06T14:04:25.592Z",
      "lastModified" : "2016-07-05T21:50:04.000Z",
      "sha1Content" : "kNXz0fqhoU15/CRsCQs5qKgSz+o",
      "primary" : true,
      "agent" : "cobaltpub",
      "path" : "/Cobalt/game-of-thrones/Stories/season-1/Ned Stark's Death.xml",
      "eomDbid" : "199",
      "publicationId" : "3228e45e-5745-412c-b521-2a63be224150"
    },
    "sectionPath" : "/season-1/"
  },
  "attributes" : {
    "tags" : [ "GameOfThrones", "war", "حدوث", "à" ],
    "tags" : [ "GameOfThrones", "war", "حدوث", "à" ]
  },
  "files" : {
    "content" : {
      "fileName" : "content.xml",
      "mimeType" : "text/xml",
      "updatedBy" : {
        "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
        "userName" : "matteo"
      },
      "updateTime" : "2016-07-06T14:04:25.980Z",
      "size" : 4007,
      "data" : "..."
    }
  },
  "links" : {
    "hyperlink" : {
      "image" : [ {
        "targetId" : "022f-0455cc697fe4-dd009fb432f0-0004-47743466261",
        "key" : 1537228672809128960,
        "maxItems" : 0
      }, {
        "targetId" : "022f-0457841d4f6c-5a49343db2ff-0004-47743466261",
        "key" : 2767011611056432640,
        "maxItems" : 0
      }, {
        "targetId" : "022f-04579d3ad2f0-5855aa05ef58-0004-47743466261",
        "key" : 3504881374004814720,
        "maxItems" : 0
      } ]
    }
  },
  "pubInfoEx" : {
    "game-of-thrones" : {
      "siteName" : "game-of-thrones",
      "status" : "LIVE",
      "publicationTime" : "2016-07-06T14:04:26.037Z",
      "publishedBy" : {
        "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
        "userName" : "matteo"
      },
      "attributes" : {
        "pubDate" : "2016-07-06T14:04:25.592Z",
        "lastModified" : "2016-07-05T21:50:04.000Z",
        "sha1Content" : "kNXz0fqhoU15/CRsCQs5qKgSz+o",
        "primary" : true,
        "agent" : "cobaltpub",
        "path" : "/Cobalt/game-of-thrones/Stories/season-1/Ned Stark's Death.xml",
        "eomDbid" : "199",
        "publicationId" : "3228e45e-5745-412c-b521-2a63be224150"
      },
      "liveInfo" : {
        "version" : "022f-0455cc697fbb-16bf8de3505e-0004-47743466261",
        "sourceVersion" : "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
        "publicationTime" : "2016-07-06T14:04:26.261Z",
        "publishedBy" : {
          "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName" : "matteo"
        }
      },
      "stageInfo" : {
        "version" : "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
        "publicationTime" : "2016-07-06T14:04:26.037Z",
        "publishedBy" : {
          "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName" : "matteo"
        }
      },
      "previewInfo" : {
        "version" : "022f-0455cc697fbb-16bf8de3505e-0004-n47743466037",
        "publishedBy" : {
          "userId" : "323dc672-e3f0-4549-8d9a-5e45d5464028",
          "userName" : "matteo"
        }
      },
      "sectionPath" : "/season-1/"
    }
  },
  "contentLength" : 0,
  "cacheKey" : "022f-0455cc697fbb-16bf8de3505e-0004",
  "lastModified" : 0,
  "cacheTimestamp" : 0,
  "dataType" : "node"
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the node does not exists.

File Content - /nodes/{id}/files/{file}

v.3.2019.05.p2

Redirect to the url serving the requested node file content stream.

File can be retrieved from both content and hierarchical node. Require the name (a.k.a. format) of the file.

RESOURCE URL

GET /nodes/{id}/files/{file}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

PATH PARAMETERS

Parameter Required Default Description

file String

Yes

-

id NodeId

Yes

Node ID

REQUEST

example

GET /api/nodes/022f-0455cc697fbb-16bf8de3505e-0004/files/content HTTP/1.1
Host: site.dev

RESPONSE

Content type

text/xml, application/json

example

<document emk-type="story">
    <headgroup emk-id="R59B2a1b8xwVGy7uhKdQ34M">
        <headline emk-id="">
            <p>Ned Stark’s Death</p>
        </headline>
    </headgroup>
    <mediagroup>
        <figure emk-type="picture">
            ...
        </figure>
    </mediagroup>
    <linkgroup/>
    <summary emk-id="R47gD0ldNxb7C1Bl8vo1gfM">
        <p>The Death of Ned</p>
    </summary>
    <content emk-id="RG62sgQu28EgbuLhJa08lxI">
        ...
    </content>
    <style/>
</document>

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the node or the file do not exist.

Pages

v.3.2019.05.p2

Methods to retrieve aggregate pages

API

GET

/pages

Retrieve page aggregate by any of its paths

GET

/pages/{id}

Retrieve page aggregate by id

GET

/pages/foreignid/{foreignId}

Retrieve page aggregate by foreign id

Read Page by foreign id - /pages/foreignid/{foreignId}

v.3.2019.05.p2

Retrieve page aggregate by foreign id

RESOURCE URL

GET /pages/foreignid/{foreignId}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

aggregator SortedSet

Yes

-

view String

Yes

View to show the content

pageNumber int

No

1

Page number for pagination of some contents

urlsAbsolute boolean

No

false

-

PATH PARAMETERS

Parameter Required Default Description

foreignId String

Yes

Foreign id of the content.

REQUEST

example 1 : requesting article page json with amp view

GET /api/pages/foreignid/7dbc4902-65c6-11e8-9702-aac7846fb597?view=amp HTTP/1.1
Host: site.dev

example 2 : requesting blog home json with page number

GET /api/pages/foreignid/7dbc4902-65c6-11e8-9702-aac7846fb597?pageNumber=2 HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "model" : {
    "id" : "model://4000-05e61d71b39e-fed070c95682-2000/RAW/1/null",
    "outputMode" : "RAW",
    "lastModified" : 0,
    "contentLength" : 0,
    "dataType" : "node",
    "data" : {
      "dataType" : "node",
      "id" : "4000-05e61d71b39e-fed070c95682-2000",
      "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
      "timestamp" : "2017-02-09T10:04:56.997Z",
      "name" : "johndoe",
      "title" : "johndoe",
      "description" : "",
      "sys" : {
        "kind" : "site",
        "baseType" : "site",
        "type" : "site",
        "creationTime" : "2017-01-20T16:22:26.077Z",
        "createdBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "updateTime" : "2017-02-09T10:04:56.997Z",
        "updatedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        }
      },
      "pubInfo" : {
        "siteName" : "johndoe",
        "status" : "LIVE",
        "publicationTime" : "2017-02-09T10:04:56.997Z",
        "publishedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "canonical" : "/",
        "baseUrls" : [ "johndoe.dev" ],
        "urls" : [ ],
        "sectionPath" : "/",
        "embargoVisible" : true
      },
      "attributes" : {
        "tags" : [ ],
        "permalink" : "/%section%/%id%/%view%",
        "webPage" : "0235-05ec3208ed77-fb160d19805c-1000",
        "hasError" : false
      },
      "staticAttributes" : {
        "status" : "ENABLED",
        "commentsEnabled" : true,
        "categories" : [ ],
        "ciao" : "ciao",
        "ciao2" : "ciao",
        "nuovo" : "nuovo"
      },
      "pubInfoEx" : {
        "johndoe" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-09T10:04:55.845Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "canonical" : "/",
          "baseUrls" : [ "johndoe.dev" ],
          "urls" : [ ],
          "liveInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
            "sourceVersion" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:56.997Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "stageInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:55.845Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "previewInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        }
      },
      "lastModified" : 1486634696997,
      "contentLength" : 0,
      "etag" : "4000-05e61d71b39e-fed070c95682-2000-66564296997"
    },
    "children" : [ "0235-05e61f0e0898-5d119582c1eb-1000", "0235-05f204a88cea-c260d9d2f4f4-1000" ],
    "nodes" : {
      "0235-05e61f0e0898-5d119582c1eb-1000" : {
        "dataType" : "node",
        "id" : "0235-05e61f0e0898-5d119582c1eb-1000",
        "version" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
        "timestamp" : "2017-02-03T15:58:11.007Z",
        "foreignId" : "fd4fde82-df2a-11e6-b594-86b645b262ad",
        "title" : "Story",
        "description" : "",
        "summary" : "Story",
        "authors" : [ "By johndoe" ],
        "sys" : {
          "kind" : "content",
          "baseType" : "article",
          "type" : "article",
          "creationTime" : "2017-01-20T16:26:56.445Z",
          "createdBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "updateTime" : "2017-02-03T15:58:11.007Z",
          "updatedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          }
        },
        "pubInfo" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-03T15:58:11.007Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "attributes" : {
            "pubDate" : "2017-02-03T15:58:10.189Z",
            "lastModified" : "2017-01-31T19:59:38.000Z",
            "sha1Content" : "so/XGLn9oyqab8+VcN82Yk7J8RY",
            "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
            "primary" : false,
            "agent" : "cobaltpub",
            "path" : "/Cobalt/johndoe/Stories/Story.xml",
            "eomDbid" : "199",
            "publicationId" : "7205a8be-3411-49ad-93ae-6711d6daa7af"
          },
          "urls" : [ {
            "url" : "my-wonderful-content",
            "type" : "TitleId"
          } ],
          "sectionPath" : "/",
          "embargoVisible" : true
        },
        "attributes" : {
          "tags" : [ ],
          "notes" : ""
        },
        "files" : {
          "content" : {
            "fileName" : "content.xml",
            "mimeType" : "text/xml",
            "updatedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "updateTime" : "2017-01-31T13:23:40.643Z",
            "size" : 1084,
            "data" : "<document> ... some content ... </document>\n"
          }
        },
        "links" : {
          "hyperlink" : {
            "image" : [ {
              "targetId" : "0235-05eba807c295-4dfc2d4c797c-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            }, {
              "targetId" : "0235-05eba807c2fc-465c47fa7043-1000",
              "key" : 2767011611056432640,
              "maxItems" : 0
            } ]
          },
          "system" : {
            "mainPicture" : [ {
              "targetId" : "0235-05eba807c295-4dfc2d4c797c-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          }
        },
        "pubInfoEx" : {
          "johndoe" : {
            "siteName" : "johndoe",
            "status" : "LIVE",
            "publicationTime" : "2017-02-03T15:58:10.678Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "attributes" : {
              "pubDate" : "2017-02-03T15:58:10.189Z",
              "lastModified" : "2017-01-31T19:59:38.000Z",
              "sha1Content" : "so/XGLn9oyqab8+VcN82Yk7J8RY",
              "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
              "primary" : false,
              "agent" : "cobaltpub",
              "path" : "/Cobalt/johndoe/Stories/Story.xml",
              "eomDbid" : "199",
              "publicationId" : "7205a8be-3411-49ad-93ae-6711d6daa7af"
            },
            "urls" : [ {
              "url" : "my-wonderful-content",
              "type" : "TitleId"
            } ],
            "liveInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
              "sourceVersion" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publicationTime" : "2017-02-03T15:58:11.007Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "stageInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publicationTime" : "2017-02-03T15:58:10.678Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "previewInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "sectionPath" : "/",
            "embargoVisible" : true
          }
        },
        "lastModified" : 1486137491007,
        "contentLength" : 0,
        "etag" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
        "picture" : "0235-05eba807c295-4dfc2d4c797c-1000"
      },
      "0235-05f204a88cea-c260d9d2f4f4-1000" : {
        "dataType" : "node",
        "id" : "0235-05f204a88cea-c260d9d2f4f4-1000",
        "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
        "timestamp" : "2017-02-01T17:40:05.333Z",
        "foreignId" : "86f7fb7c-e21b-11e6-b594-86b645b262ad",
        "title" : "Story",
        "description" : "",
        "summary" : "Story",
        "authors" : [ "By johndoe" ],
        "sys" : {
          "kind" : "content",
          "baseType" : "article",
          "type" : "article",
          "creationTime" : "2017-01-26T14:23:04.563Z",
          "createdBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "updateTime" : "2017-02-01T17:40:05.333Z",
          "updatedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          }
        },
        "pubInfo" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-01T17:40:05.333Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "attributes" : {
            "pubDate" : "2017-02-01T17:40:04.737Z",
            "lastModified" : "2017-01-24T17:53:54.000Z",
            "sha1Content" : "/JI5GXMW5+U/F6XEyxRp3cSUMTg",
            "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
            "primary" : false,
            "agent" : "cobaltpub",
            "path" : "/Cobalt/johndoe/Stories/Story.xml",
            "eomDbid" : "199",
            "publicationId" : "30f1c585-3785-4bee-97cc-01bc6390fe70"
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        },
        "attributes" : {
          "tags" : [ ],
          "notes" : ""
        },
        "files" : {
          "content" : {
            "fileName" : "content.xml",
            "mimeType" : "text/xml",
            "updatedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "updateTime" : "2017-01-27T09:37:34.555Z",
            "size" : 8539,
            "data" : "<document> ... some content ... </document>\n"
          }
        },
        "links" : {
          "hyperlink" : {
            "image" : [ {
              "targetId" : "0235-05f204a88c9b-059ddcc1eea8-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          },
          "system" : {
            "mainPicture" : [ {
              "targetId" : "0235-05f204a88c9b-059ddcc1eea8-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          }
        },
        "pubInfoEx" : {
          "johndoe" : {
            "siteName" : "johndoe",
            "status" : "LIVE",
            "publicationTime" : "2017-02-01T17:40:05.046Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "attributes" : {
              "pubDate" : "2017-02-01T17:40:04.737Z",
              "lastModified" : "2017-01-24T17:53:54.000Z",
              "sha1Content" : "/JI5GXMW5+U/F6XEyxRp3cSUMTg",
              "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
              "primary" : false,
              "agent" : "cobaltpub",
              "path" : "/Cobalt/johndoe/Stories/Story.xml",
              "eomDbid" : "199",
              "publicationId" : "30f1c585-3785-4bee-97cc-01bc6390fe70"
            },
            "liveInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
              "sourceVersion" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publicationTime" : "2017-02-01T17:40:05.333Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "stageInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publicationTime" : "2017-02-01T17:40:05.046Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "previewInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "sectionPath" : "/",
            "embargoVisible" : true
          }
        },
        "lastModified" : 1485970805333,
        "contentLength" : 0,
        "etag" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
        "picture" : "0235-05f204a88c9b-059ddcc1eea8-1000"
      }
    },
    "defaultContent" : false,
    "page" : 1,
    "pageNumber" : 1,
    "aggregators" : [ ]
  },
  "siteNode" : {
    "id" : "4000-05e61d71b39e-fed070c95682-2000",
    "name" : "johndoe",
    "title" : "johndoe",
    "description" : "",
    "uri" : "/",
    "nodeData" : {
      "dataType" : "node",
      "id" : "4000-05e61d71b39e-fed070c95682-2000",
      "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
      "timestamp" : "2017-02-09T10:04:56.997Z",
      "name" : "johndoe",
      "title" : "johndoe",
      "description" : "",
      "sys" : {
        "kind" : "site",
        "baseType" : "site",
        "type" : "site",
        "creationTime" : "2017-01-20T16:22:26.077Z",
        "createdBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "updateTime" : "2017-02-09T10:04:56.997Z",
        "updatedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        }
      },
      "pubInfo" : {
        "siteName" : "johndoe",
        "status" : "LIVE",
        "publicationTime" : "2017-02-09T10:04:56.997Z",
        "publishedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "canonical" : "/",
        "baseUrls" : [ "johndoe.dev" ],
        "urls" : [ ],
        "sectionPath" : "/",
        "embargoVisible" : true
      },
      "attributes" : {
        "tags" : [ ],
        "permalink" : "/%section%/%id%/%view%",
        "webPage" : "0235-05ec3208ed77-fb160d19805c-1000",
        "hasError" : false
      },
      "staticAttributes" : {
        "status" : "ENABLED",
        "commentsEnabled" : true,
        "categories" : [ ]
      },
      "pubInfoEx" : {
        "johndoe" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-09T10:04:55.845Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "canonical" : "/",
          "baseUrls" : [ "johndoe.dev" ],
          "urls" : [ ],
          "liveInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
            "sourceVersion" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:56.997Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "stageInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:55.845Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "previewInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        }
      },
      "hierarchyChildrenIds" : [ "4000-06107870577e-35621a0b3d02-2001", "4000-060e2ad61b91-c9ff083add46-2001" ],
      "lastModified" : 1486634696997,
      "contentLength" : 0,
      "etag" : "4000-05e61d71b39e-fed070c95682-2000-66564296997"
    },
    "type" : "site",
    "path" : "/",
    "status" : "ENABLED",
    "hostnames" : [ "johndoe.dev" ],
    "commentsEnabled" : true,
    "multivariateTests" : { },
    "permalink" : "/%section%/%id%/%view%"
  },
  "siteData" : {
    "siteName" : "johndoe",
    "viewStatus" : "LIVE",
    "custom" : {
      "ciao" : "ciao",
      "ciao2" : "ciao",
      "nuovo" : "nuovo"
    },
    "categories" : [ ]
  },
  "request" : {
    "scheme" : "http",
    "serverName" : "johndoe.dev",
    "serverPort" : 8480,
    "contextPath" : "",
    "development" : true,
    "siteKey" : {
      "siteName" : "johndoe",
      "viewStatus" : "LIVE"
    },
    "contextBaseUri" : "http://johndoe.dev:8480",
    "include" : false,
    "previewDefaultContent" : false,
    "cacheDisabled" : false
  },
  "theme" : {
    "name" : "default",
    "title" : "Cobalt Default Theme",
    "extension" : "ftl",
    "url" : "file:/Users/john.doe/repo/p4/john.doe_MacBook/head2013/java/portal/com.eidosmedia.portal.pom/src/themes/default/",
    "css" : "/assets/themes/default/css/default.css"
  },
  "viewData" : {
    "view" : null,
    "templateName" : "default/templates/site.ftl",
    "requestedTheme" : null,
    "requestedLayout" : null,
    "requestedVariant" : null
  },
  "configuration" : {
    "comments" : {
      "enabled" : true,
      "url" : "",
      "avatarUrl" : "http://localhost:8480/directory/users/picture?id=",
      "domainId" : "4000-05e61d71b39e-fed070c95682-2000",
      "forumId" : "4000-05e61d71b39e-fed070c95682-2000",
      "threadId" : "default:4000-05e61d71b39e-fed070c95682-2000:4000-05e61d71b39e-fed070c95682-2000",
      "maxResults" : 20,
      "refreshInterval" : 60
    }
  },
  "multivariateTesting" : {
    "activeTests" : { }
  }
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the requested page does not exists.

Read Page - /pages/{id}

v.3.2019.05.p2

Retrieve page aggregate by id

RESOURCE URL

GET /pages/{id}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

aggregator SortedSet

Yes

-

view String

Yes

View to show the content

pageNumber int

No

1

Page number for pagination of some contents

urlsAbsolute boolean

No

false

-

PATH PARAMETERS

Parameter Required Default Description

id EntityId

Yes

Id of the content.

REQUEST

example 1 : requesting article page json with amp view

GET /api/pages/022f-0455cc697fbb-16bf8de3505e-0004?view=amp HTTP/1.1
Host: site.dev

example 2 : requesting blog home json with page number

GET /api/pages/022f-0455cc697fbb-16bf8de3505e-0004?pageNumber=2 HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "model" : {
    "id" : "model://4000-05e61d71b39e-fed070c95682-2000/RAW/1/null",
    "outputMode" : "RAW",
    "lastModified" : 0,
    "contentLength" : 0,
    "dataType" : "node",
    "data" : {
      "dataType" : "node",
      "id" : "4000-05e61d71b39e-fed070c95682-2000",
      "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
      "timestamp" : "2017-02-09T10:04:56.997Z",
      "name" : "johndoe",
      "title" : "johndoe",
      "description" : "",
      "sys" : {
        "kind" : "site",
        "baseType" : "site",
        "type" : "site",
        "creationTime" : "2017-01-20T16:22:26.077Z",
        "createdBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "updateTime" : "2017-02-09T10:04:56.997Z",
        "updatedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        }
      },
      "pubInfo" : {
        "siteName" : "johndoe",
        "status" : "LIVE",
        "publicationTime" : "2017-02-09T10:04:56.997Z",
        "publishedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "canonical" : "/",
        "baseUrls" : [ "johndoe.dev" ],
        "urls" : [ ],
        "sectionPath" : "/",
        "embargoVisible" : true
      },
      "attributes" : {
        "tags" : [ ],
        "permalink" : "/%section%/%id%/%view%",
        "webPage" : "0235-05ec3208ed77-fb160d19805c-1000",
        "hasError" : false
      },
      "staticAttributes" : {
        "status" : "ENABLED",
        "commentsEnabled" : true,
        "categories" : [ ],
        "ciao" : "ciao",
        "ciao2" : "ciao",
        "nuovo" : "nuovo"
      },
      "pubInfoEx" : {
        "johndoe" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-09T10:04:55.845Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "canonical" : "/",
          "baseUrls" : [ "johndoe.dev" ],
          "urls" : [ ],
          "liveInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
            "sourceVersion" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:56.997Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "stageInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:55.845Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "previewInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        }
      },
      "lastModified" : 1486634696997,
      "contentLength" : 0,
      "etag" : "4000-05e61d71b39e-fed070c95682-2000-66564296997"
    },
    "children" : [ "0235-05e61f0e0898-5d119582c1eb-1000", "0235-05f204a88cea-c260d9d2f4f4-1000" ],
    "nodes" : {
      "0235-05e61f0e0898-5d119582c1eb-1000" : {
        "dataType" : "node",
        "id" : "0235-05e61f0e0898-5d119582c1eb-1000",
        "version" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
        "timestamp" : "2017-02-03T15:58:11.007Z",
        "foreignId" : "fd4fde82-df2a-11e6-b594-86b645b262ad",
        "title" : "Story",
        "description" : "",
        "summary" : "Story",
        "authors" : [ "By johndoe" ],
        "sys" : {
          "kind" : "content",
          "baseType" : "article",
          "type" : "article",
          "creationTime" : "2017-01-20T16:26:56.445Z",
          "createdBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "updateTime" : "2017-02-03T15:58:11.007Z",
          "updatedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          }
        },
        "pubInfo" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-03T15:58:11.007Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "attributes" : {
            "pubDate" : "2017-02-03T15:58:10.189Z",
            "lastModified" : "2017-01-31T19:59:38.000Z",
            "sha1Content" : "so/XGLn9oyqab8+VcN82Yk7J8RY",
            "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
            "primary" : false,
            "agent" : "cobaltpub",
            "path" : "/Cobalt/johndoe/Stories/Story.xml",
            "eomDbid" : "199",
            "publicationId" : "7205a8be-3411-49ad-93ae-6711d6daa7af"
          },
          "urls" : [ {
            "url" : "my-wonderful-content",
            "type" : "TitleId"
          } ],
          "sectionPath" : "/",
          "embargoVisible" : true
        },
        "attributes" : {
          "tags" : [ ],
          "notes" : ""
        },
        "files" : {
          "content" : {
            "fileName" : "content.xml",
            "mimeType" : "text/xml",
            "updatedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "updateTime" : "2017-01-31T13:23:40.643Z",
            "size" : 1084,
            "data" : "<document> ... some content ... </document>\n"
          }
        },
        "links" : {
          "hyperlink" : {
            "image" : [ {
              "targetId" : "0235-05eba807c295-4dfc2d4c797c-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            }, {
              "targetId" : "0235-05eba807c2fc-465c47fa7043-1000",
              "key" : 2767011611056432640,
              "maxItems" : 0
            } ]
          },
          "system" : {
            "mainPicture" : [ {
              "targetId" : "0235-05eba807c295-4dfc2d4c797c-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          }
        },
        "pubInfoEx" : {
          "johndoe" : {
            "siteName" : "johndoe",
            "status" : "LIVE",
            "publicationTime" : "2017-02-03T15:58:10.678Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "attributes" : {
              "pubDate" : "2017-02-03T15:58:10.189Z",
              "lastModified" : "2017-01-31T19:59:38.000Z",
              "sha1Content" : "so/XGLn9oyqab8+VcN82Yk7J8RY",
              "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
              "primary" : false,
              "agent" : "cobaltpub",
              "path" : "/Cobalt/johndoe/Stories/Story.xml",
              "eomDbid" : "199",
              "publicationId" : "7205a8be-3411-49ad-93ae-6711d6daa7af"
            },
            "urls" : [ {
              "url" : "my-wonderful-content",
              "type" : "TitleId"
            } ],
            "liveInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
              "sourceVersion" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publicationTime" : "2017-02-03T15:58:11.007Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "stageInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publicationTime" : "2017-02-03T15:58:10.678Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "previewInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "sectionPath" : "/",
            "embargoVisible" : true
          }
        },
        "lastModified" : 1486137491007,
        "contentLength" : 0,
        "etag" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
        "picture" : "0235-05eba807c295-4dfc2d4c797c-1000"
      },
      "0235-05f204a88cea-c260d9d2f4f4-1000" : {
        "dataType" : "node",
        "id" : "0235-05f204a88cea-c260d9d2f4f4-1000",
        "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
        "timestamp" : "2017-02-01T17:40:05.333Z",
        "foreignId" : "86f7fb7c-e21b-11e6-b594-86b645b262ad",
        "title" : "Story",
        "description" : "",
        "summary" : "Story",
        "authors" : [ "By johndoe" ],
        "sys" : {
          "kind" : "content",
          "baseType" : "article",
          "type" : "article",
          "creationTime" : "2017-01-26T14:23:04.563Z",
          "createdBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "updateTime" : "2017-02-01T17:40:05.333Z",
          "updatedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          }
        },
        "pubInfo" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-01T17:40:05.333Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "attributes" : {
            "pubDate" : "2017-02-01T17:40:04.737Z",
            "lastModified" : "2017-01-24T17:53:54.000Z",
            "sha1Content" : "/JI5GXMW5+U/F6XEyxRp3cSUMTg",
            "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
            "primary" : false,
            "agent" : "cobaltpub",
            "path" : "/Cobalt/johndoe/Stories/Story.xml",
            "eomDbid" : "199",
            "publicationId" : "30f1c585-3785-4bee-97cc-01bc6390fe70"
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        },
        "attributes" : {
          "tags" : [ ],
          "notes" : ""
        },
        "files" : {
          "content" : {
            "fileName" : "content.xml",
            "mimeType" : "text/xml",
            "updatedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "updateTime" : "2017-01-27T09:37:34.555Z",
            "size" : 8539,
            "data" : "<document> ... some content ... </document>\n"
          }
        },
        "links" : {
          "hyperlink" : {
            "image" : [ {
              "targetId" : "0235-05f204a88c9b-059ddcc1eea8-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          },
          "system" : {
            "mainPicture" : [ {
              "targetId" : "0235-05f204a88c9b-059ddcc1eea8-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          }
        },
        "pubInfoEx" : {
          "johndoe" : {
            "siteName" : "johndoe",
            "status" : "LIVE",
            "publicationTime" : "2017-02-01T17:40:05.046Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "attributes" : {
              "pubDate" : "2017-02-01T17:40:04.737Z",
              "lastModified" : "2017-01-24T17:53:54.000Z",
              "sha1Content" : "/JI5GXMW5+U/F6XEyxRp3cSUMTg",
              "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
              "primary" : false,
              "agent" : "cobaltpub",
              "path" : "/Cobalt/johndoe/Stories/Story.xml",
              "eomDbid" : "199",
              "publicationId" : "30f1c585-3785-4bee-97cc-01bc6390fe70"
            },
            "liveInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
              "sourceVersion" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publicationTime" : "2017-02-01T17:40:05.333Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "stageInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publicationTime" : "2017-02-01T17:40:05.046Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "previewInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "sectionPath" : "/",
            "embargoVisible" : true
          }
        },
        "lastModified" : 1485970805333,
        "contentLength" : 0,
        "etag" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
        "picture" : "0235-05f204a88c9b-059ddcc1eea8-1000"
      }
    },
    "defaultContent" : false,
    "page" : 1,
    "pageNumber" : 1,
    "aggregators" : [ ]
  },
  "siteNode" : {
    "id" : "4000-05e61d71b39e-fed070c95682-2000",
    "name" : "johndoe",
    "title" : "johndoe",
    "description" : "",
    "uri" : "/",
    "nodeData" : {
      "dataType" : "node",
      "id" : "4000-05e61d71b39e-fed070c95682-2000",
      "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
      "timestamp" : "2017-02-09T10:04:56.997Z",
      "name" : "johndoe",
      "title" : "johndoe",
      "description" : "",
      "sys" : {
        "kind" : "site",
        "baseType" : "site",
        "type" : "site",
        "creationTime" : "2017-01-20T16:22:26.077Z",
        "createdBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "updateTime" : "2017-02-09T10:04:56.997Z",
        "updatedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        }
      },
      "pubInfo" : {
        "siteName" : "johndoe",
        "status" : "LIVE",
        "publicationTime" : "2017-02-09T10:04:56.997Z",
        "publishedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "canonical" : "/",
        "baseUrls" : [ "johndoe.dev" ],
        "urls" : [ ],
        "sectionPath" : "/",
        "embargoVisible" : true
      },
      "attributes" : {
        "tags" : [ ],
        "permalink" : "/%section%/%id%/%view%",
        "webPage" : "0235-05ec3208ed77-fb160d19805c-1000",
        "hasError" : false
      },
      "staticAttributes" : {
        "status" : "ENABLED",
        "commentsEnabled" : true,
        "categories" : [ ]
      },
      "pubInfoEx" : {
        "johndoe" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-09T10:04:55.845Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "canonical" : "/",
          "baseUrls" : [ "johndoe.dev" ],
          "urls" : [ ],
          "liveInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
            "sourceVersion" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:56.997Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "stageInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:55.845Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "previewInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        }
      },
      "hierarchyChildrenIds" : [ "4000-06107870577e-35621a0b3d02-2001", "4000-060e2ad61b91-c9ff083add46-2001" ],
      "lastModified" : 1486634696997,
      "contentLength" : 0,
      "etag" : "4000-05e61d71b39e-fed070c95682-2000-66564296997"
    },
    "type" : "site",
    "path" : "/",
    "status" : "ENABLED",
    "hostnames" : [ "johndoe.dev" ],
    "commentsEnabled" : true,
    "multivariateTests" : { },
    "permalink" : "/%section%/%id%/%view%"
  },
  "siteData" : {
    "siteName" : "johndoe",
    "viewStatus" : "LIVE",
    "custom" : {
      "ciao" : "ciao",
      "ciao2" : "ciao",
      "nuovo" : "nuovo"
    },
    "categories" : [ ]
  },
  "request" : {
    "scheme" : "http",
    "serverName" : "johndoe.dev",
    "serverPort" : 8480,
    "contextPath" : "",
    "development" : true,
    "siteKey" : {
      "siteName" : "johndoe",
      "viewStatus" : "LIVE"
    },
    "contextBaseUri" : "http://johndoe.dev:8480",
    "include" : false,
    "previewDefaultContent" : false,
    "cacheDisabled" : false
  },
  "theme" : {
    "name" : "default",
    "title" : "Cobalt Default Theme",
    "extension" : "ftl",
    "url" : "file:/Users/john.doe/repo/p4/john.doe_MacBook/head2013/java/portal/com.eidosmedia.portal.pom/src/themes/default/",
    "css" : "/assets/themes/default/css/default.css"
  },
  "viewData" : {
    "view" : null,
    "templateName" : "default/templates/site.ftl",
    "requestedTheme" : null,
    "requestedLayout" : null,
    "requestedVariant" : null
  },
  "configuration" : {
    "comments" : {
      "enabled" : true,
      "url" : "",
      "avatarUrl" : "http://localhost:8480/directory/users/picture?id=",
      "domainId" : "4000-05e61d71b39e-fed070c95682-2000",
      "forumId" : "4000-05e61d71b39e-fed070c95682-2000",
      "threadId" : "default:4000-05e61d71b39e-fed070c95682-2000:4000-05e61d71b39e-fed070c95682-2000",
      "maxResults" : 20,
      "refreshInterval" : 60
    }
  },
  "multivariateTesting" : {
    "activeTests" : { }
  }
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the requested page does not exists.

Read Page by path - /pages

v.3.2019.05.p2

Retrieve page aggregate by any of its paths

Any relative url that resolves the content can be used as the path parameter.

RESOURCE URL

GET /pages

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

aggregator SortedSet

Yes

-

url String

Yes

Relative (without scheme) URL of the content.

urlsAbsolute boolean

No

false

-

REQUEST

example : requesting article page json

GET /api/pages?url=escaped-url-of-the-page HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "model" : {
    "id" : "model://4000-05e61d71b39e-fed070c95682-2000/RAW/1/null",
    "outputMode" : "RAW",
    "lastModified" : 0,
    "contentLength" : 0,
    "dataType" : "node",
    "data" : {
      "dataType" : "node",
      "id" : "4000-05e61d71b39e-fed070c95682-2000",
      "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
      "timestamp" : "2017-02-09T10:04:56.997Z",
      "name" : "johndoe",
      "title" : "johndoe",
      "description" : "",
      "sys" : {
        "kind" : "site",
        "baseType" : "site",
        "type" : "site",
        "creationTime" : "2017-01-20T16:22:26.077Z",
        "createdBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "updateTime" : "2017-02-09T10:04:56.997Z",
        "updatedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        }
      },
      "pubInfo" : {
        "siteName" : "johndoe",
        "status" : "LIVE",
        "publicationTime" : "2017-02-09T10:04:56.997Z",
        "publishedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "canonical" : "/",
        "baseUrls" : [ "johndoe.dev" ],
        "urls" : [ ],
        "sectionPath" : "/",
        "embargoVisible" : true
      },
      "attributes" : {
        "tags" : [ ],
        "permalink" : "/%section%/%id%/%view%",
        "webPage" : "0235-05ec3208ed77-fb160d19805c-1000",
        "hasError" : false
      },
      "staticAttributes" : {
        "status" : "ENABLED",
        "commentsEnabled" : true,
        "categories" : [ ],
        "ciao" : "ciao",
        "ciao2" : "ciao",
        "nuovo" : "nuovo"
      },
      "pubInfoEx" : {
        "johndoe" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-09T10:04:55.845Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "canonical" : "/",
          "baseUrls" : [ "johndoe.dev" ],
          "urls" : [ ],
          "liveInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
            "sourceVersion" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:56.997Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "stageInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:55.845Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "previewInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        }
      },
      "lastModified" : 1486634696997,
      "contentLength" : 0,
      "etag" : "4000-05e61d71b39e-fed070c95682-2000-66564296997"
    },
    "children" : [ "0235-05e61f0e0898-5d119582c1eb-1000", "0235-05f204a88cea-c260d9d2f4f4-1000" ],
    "nodes" : {
      "0235-05e61f0e0898-5d119582c1eb-1000" : {
        "dataType" : "node",
        "id" : "0235-05e61f0e0898-5d119582c1eb-1000",
        "version" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
        "timestamp" : "2017-02-03T15:58:11.007Z",
        "foreignId" : "fd4fde82-df2a-11e6-b594-86b645b262ad",
        "title" : "Story",
        "description" : "",
        "summary" : "Story",
        "authors" : [ "By johndoe" ],
        "sys" : {
          "kind" : "content",
          "baseType" : "article",
          "type" : "article",
          "creationTime" : "2017-01-20T16:26:56.445Z",
          "createdBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "updateTime" : "2017-02-03T15:58:11.007Z",
          "updatedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          }
        },
        "pubInfo" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-03T15:58:11.007Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "attributes" : {
            "pubDate" : "2017-02-03T15:58:10.189Z",
            "lastModified" : "2017-01-31T19:59:38.000Z",
            "sha1Content" : "so/XGLn9oyqab8+VcN82Yk7J8RY",
            "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
            "primary" : false,
            "agent" : "cobaltpub",
            "path" : "/Cobalt/johndoe/Stories/Story.xml",
            "eomDbid" : "199",
            "publicationId" : "7205a8be-3411-49ad-93ae-6711d6daa7af"
          },
          "urls" : [ {
            "url" : "my-wonderful-content",
            "type" : "TitleId"
          } ],
          "sectionPath" : "/",
          "embargoVisible" : true
        },
        "attributes" : {
          "tags" : [ ],
          "notes" : ""
        },
        "files" : {
          "content" : {
            "fileName" : "content.xml",
            "mimeType" : "text/xml",
            "updatedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "updateTime" : "2017-01-31T13:23:40.643Z",
            "size" : 1084,
            "data" : "<document> ... some content ... </document>\n"
          }
        },
        "links" : {
          "hyperlink" : {
            "image" : [ {
              "targetId" : "0235-05eba807c295-4dfc2d4c797c-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            }, {
              "targetId" : "0235-05eba807c2fc-465c47fa7043-1000",
              "key" : 2767011611056432640,
              "maxItems" : 0
            } ]
          },
          "system" : {
            "mainPicture" : [ {
              "targetId" : "0235-05eba807c295-4dfc2d4c797c-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          }
        },
        "pubInfoEx" : {
          "johndoe" : {
            "siteName" : "johndoe",
            "status" : "LIVE",
            "publicationTime" : "2017-02-03T15:58:10.678Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "attributes" : {
              "pubDate" : "2017-02-03T15:58:10.189Z",
              "lastModified" : "2017-01-31T19:59:38.000Z",
              "sha1Content" : "so/XGLn9oyqab8+VcN82Yk7J8RY",
              "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
              "primary" : false,
              "agent" : "cobaltpub",
              "path" : "/Cobalt/johndoe/Stories/Story.xml",
              "eomDbid" : "199",
              "publicationId" : "7205a8be-3411-49ad-93ae-6711d6daa7af"
            },
            "urls" : [ {
              "url" : "my-wonderful-content",
              "type" : "TitleId"
            } ],
            "liveInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
              "sourceVersion" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publicationTime" : "2017-02-03T15:58:11.007Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "stageInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publicationTime" : "2017-02-03T15:58:10.678Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "previewInfo" : {
              "version" : "0235-05e61f0e0898-5d119582c1eb-1000-n66067090678",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "sectionPath" : "/",
            "embargoVisible" : true
          }
        },
        "lastModified" : 1486137491007,
        "contentLength" : 0,
        "etag" : "0235-05e61f0e0898-5d119582c1eb-1000-66067091007",
        "picture" : "0235-05eba807c295-4dfc2d4c797c-1000"
      },
      "0235-05f204a88cea-c260d9d2f4f4-1000" : {
        "dataType" : "node",
        "id" : "0235-05f204a88cea-c260d9d2f4f4-1000",
        "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
        "timestamp" : "2017-02-01T17:40:05.333Z",
        "foreignId" : "86f7fb7c-e21b-11e6-b594-86b645b262ad",
        "title" : "Story",
        "description" : "",
        "summary" : "Story",
        "authors" : [ "By johndoe" ],
        "sys" : {
          "kind" : "content",
          "baseType" : "article",
          "type" : "article",
          "creationTime" : "2017-01-26T14:23:04.563Z",
          "createdBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "updateTime" : "2017-02-01T17:40:05.333Z",
          "updatedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          }
        },
        "pubInfo" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-01T17:40:05.333Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "attributes" : {
            "pubDate" : "2017-02-01T17:40:04.737Z",
            "lastModified" : "2017-01-24T17:53:54.000Z",
            "sha1Content" : "/JI5GXMW5+U/F6XEyxRp3cSUMTg",
            "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
            "primary" : false,
            "agent" : "cobaltpub",
            "path" : "/Cobalt/johndoe/Stories/Story.xml",
            "eomDbid" : "199",
            "publicationId" : "30f1c585-3785-4bee-97cc-01bc6390fe70"
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        },
        "attributes" : {
          "tags" : [ ],
          "notes" : ""
        },
        "files" : {
          "content" : {
            "fileName" : "content.xml",
            "mimeType" : "text/xml",
            "updatedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "updateTime" : "2017-01-27T09:37:34.555Z",
            "size" : 8539,
            "data" : "<document> ... some content ... </document>\n"
          }
        },
        "links" : {
          "hyperlink" : {
            "image" : [ {
              "targetId" : "0235-05f204a88c9b-059ddcc1eea8-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          },
          "system" : {
            "mainPicture" : [ {
              "targetId" : "0235-05f204a88c9b-059ddcc1eea8-1000",
              "key" : 1537228672809128960,
              "maxItems" : 0
            } ]
          }
        },
        "pubInfoEx" : {
          "johndoe" : {
            "siteName" : "johndoe",
            "status" : "LIVE",
            "publicationTime" : "2017-02-01T17:40:05.046Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            },
            "attributes" : {
              "pubDate" : "2017-02-01T17:40:04.737Z",
              "lastModified" : "2017-01-24T17:53:54.000Z",
              "sha1Content" : "/JI5GXMW5+U/F6XEyxRp3cSUMTg",
              "sha1Correlations" : "2jmj7l5rSw0yVb/vlWAYkK/YBwk",
              "primary" : false,
              "agent" : "cobaltpub",
              "path" : "/Cobalt/johndoe/Stories/Story.xml",
              "eomDbid" : "199",
              "publicationId" : "30f1c585-3785-4bee-97cc-01bc6390fe70"
            },
            "liveInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
              "sourceVersion" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publicationTime" : "2017-02-01T17:40:05.333Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "stageInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publicationTime" : "2017-02-01T17:40:05.046Z",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "previewInfo" : {
              "version" : "0235-05f204a88cea-c260d9d2f4f4-1000-n65900405046",
              "publishedBy" : {
                "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
                "userName" : "johndoe"
              }
            },
            "sectionPath" : "/",
            "embargoVisible" : true
          }
        },
        "lastModified" : 1485970805333,
        "contentLength" : 0,
        "etag" : "0235-05f204a88cea-c260d9d2f4f4-1000-65900405333",
        "picture" : "0235-05f204a88c9b-059ddcc1eea8-1000"
      }
    },
    "defaultContent" : false,
    "page" : 1,
    "pageNumber" : 1,
    "aggregators" : [ ]
  },
  "siteNode" : {
    "id" : "4000-05e61d71b39e-fed070c95682-2000",
    "name" : "johndoe",
    "title" : "johndoe",
    "description" : "",
    "uri" : "/",
    "nodeData" : {
      "dataType" : "node",
      "id" : "4000-05e61d71b39e-fed070c95682-2000",
      "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
      "timestamp" : "2017-02-09T10:04:56.997Z",
      "name" : "johndoe",
      "title" : "johndoe",
      "description" : "",
      "sys" : {
        "kind" : "site",
        "baseType" : "site",
        "type" : "site",
        "creationTime" : "2017-01-20T16:22:26.077Z",
        "createdBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "updateTime" : "2017-02-09T10:04:56.997Z",
        "updatedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        }
      },
      "pubInfo" : {
        "siteName" : "johndoe",
        "status" : "LIVE",
        "publicationTime" : "2017-02-09T10:04:56.997Z",
        "publishedBy" : {
          "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
          "userName" : "johndoe"
        },
        "canonical" : "/",
        "baseUrls" : [ "johndoe.dev" ],
        "urls" : [ ],
        "sectionPath" : "/",
        "embargoVisible" : true
      },
      "attributes" : {
        "tags" : [ ],
        "permalink" : "/%section%/%id%/%view%",
        "webPage" : "0235-05ec3208ed77-fb160d19805c-1000",
        "hasError" : false
      },
      "staticAttributes" : {
        "status" : "ENABLED",
        "commentsEnabled" : true,
        "categories" : [ ]
      },
      "pubInfoEx" : {
        "johndoe" : {
          "siteName" : "johndoe",
          "status" : "LIVE",
          "publicationTime" : "2017-02-09T10:04:55.845Z",
          "publishedBy" : {
            "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
            "userName" : "johndoe"
          },
          "canonical" : "/",
          "baseUrls" : [ "johndoe.dev" ],
          "urls" : [ ],
          "liveInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-66564296997",
            "sourceVersion" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:56.997Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "stageInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publicationTime" : "2017-02-09T10:04:55.845Z",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "previewInfo" : {
            "version" : "4000-05e61d71b39e-fed070c95682-2000-n66564295845",
            "publishedBy" : {
              "userId" : "7ee16533-3a39-452e-be21-4e71297f629f",
              "userName" : "johndoe"
            }
          },
          "sectionPath" : "/",
          "embargoVisible" : true
        }
      },
      "hierarchyChildrenIds" : [ "4000-06107870577e-35621a0b3d02-2001", "4000-060e2ad61b91-c9ff083add46-2001" ],
      "lastModified" : 1486634696997,
      "contentLength" : 0,
      "etag" : "4000-05e61d71b39e-fed070c95682-2000-66564296997"
    },
    "type" : "site",
    "path" : "/",
    "status" : "ENABLED",
    "hostnames" : [ "johndoe.dev" ],
    "commentsEnabled" : true,
    "multivariateTests" : { },
    "permalink" : "/%section%/%id%/%view%"
  },
  "siteData" : {
    "siteName" : "johndoe",
    "viewStatus" : "LIVE",
    "custom" : {
      "ciao" : "ciao",
      "ciao2" : "ciao",
      "nuovo" : "nuovo"
    },
    "categories" : [ ]
  },
  "request" : {
    "scheme" : "http",
    "serverName" : "johndoe.dev",
    "serverPort" : 8480,
    "contextPath" : "",
    "development" : true,
    "siteKey" : {
      "siteName" : "johndoe",
      "viewStatus" : "LIVE"
    },
    "contextBaseUri" : "http://johndoe.dev:8480",
    "include" : false,
    "previewDefaultContent" : false,
    "cacheDisabled" : false
  },
  "theme" : {
    "name" : "default",
    "title" : "Cobalt Default Theme",
    "extension" : "ftl",
    "url" : "file:/Users/john.doe/repo/p4/john.doe_MacBook/head2013/java/portal/com.eidosmedia.portal.pom/src/themes/default/",
    "css" : "/assets/themes/default/css/default.css"
  },
  "viewData" : {
    "view" : null,
    "templateName" : "default/templates/site.ftl",
    "requestedTheme" : null,
    "requestedLayout" : null,
    "requestedVariant" : null
  },
  "configuration" : {
    "comments" : {
      "enabled" : true,
      "url" : "",
      "avatarUrl" : "http://localhost:8480/directory/users/picture?id=",
      "domainId" : "4000-05e61d71b39e-fed070c95682-2000",
      "forumId" : "4000-05e61d71b39e-fed070c95682-2000",
      "threadId" : "default:4000-05e61d71b39e-fed070c95682-2000:4000-05e61d71b39e-fed070c95682-2000",
      "maxResults" : 20,
      "refreshInterval" : 60
    }
  },
  "multivariateTesting" : {
    "activeTests" : { }
  }
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found or if the requested page does not exists.

Themes

v.3.2019.05.p2

Methods to access themes info.

API

GET

/themes

List all themes.

GET

/themes/{name}

Read theme data.

List all themes - /themes

v.3.2019.05.p2

List all themes.

Return a list of themes available for the site.

RESOURCE URL

GET /themes

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

limit int

No

20

Page limit

offset int

No

0

Page offset

REQUEST

example

GET /api/themes HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "count": 1,
  "result": [
    {
      "name": "default",
      "title": "Cobalt Default Theme",
      "author": "Cobalt Dev Team",
      "extension": "ftl",
      "version": "0.0.1",
      "description": "Cobalt Default Theme - Based on Clean Blog (http://startbootstrap.com/template-overviews/clean-blog/)",
      "thumb": "http://site.dev:8080/default/thumb.jpg",
      "templates": {
        "archive": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/archive.ftl",
            "type": "archive"
          }
        ],
        "section": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/section.ftl",
            "type": "section"
          }
        ],
        "error": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/error.ftl",
            "type": "error"
          }
        ],
        "article": [
          {
            "name": "amp",
            "resource": "http://site.dev:8080/default/templates/article-amp.ftl",
            "type": "article"
          },
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/article.ftl",
            "type": "article",
            "thumb": "http://site.dev:8080/default/templates/article.jpg"
          }
        ],
        "search": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/search.ftl",
            "type": "search"
          }
        ],
        "site": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/site.ftl",
            "type": "site",
            "thumb": "http://site.dev:8080/default/templates/site.jpg"
          }
        ],
        "searchSidebar": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/searchSidebar.ftl",
            "type": "searchSidebar"
          }
        ],
        "sidebar": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/sidebar.ftl",
            "type": "sidebar"
          }
        ],
        "registration": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/registration.ftl",
            "type": "registration"
          }
        ],
        "styles": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/styles.ftl",
            "type": "styles"
          }
        ],
        "tag": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/tag.ftl",
            "type": "tag"
          }
        ],
        "scripts": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/scripts.ftl",
            "type": "scripts"
          }
        ],
        "verification": [
          {
            "name": "default",
            "resource": "http://site.dev:8080/default/templates/verification.ftl",
            "type": "verification"
          }
        ]
      },
      "variants": [
        {
          "name": "default",
          "resource": "http://site.dev:8080/assets/themes/default/css/default.css",
          "thumb": "http://site.dev:8080/assets/themes/default/css/default.jpg"
        }
      ],
      "lastModified": 0
    }
  ],
  "limit": 10,
  "offset": 0
}

Read theme - /themes/{name}

v.3.2019.05.p2

Read theme data.

Return information about the specified theme. The theme name correspond to the name of the theme folder inside the themes directory

RESOURCE URL

GET /themes/{name}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

PATH PARAMETERS

Parameter Required Default Description

name String

Yes

Theme name

REQUEST

example

GET /api/themes/default HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
  "name": "default",
  "title": "Cobalt Default Theme",
  "author": "Cobalt Dev Team",
  "extension": "ftl",
  "version": "0.0.1",
  "description": "Cobalt Default Theme - Based on Clean Blog (http://startbootstrap.com/template-overviews/clean-blog/)",
  "thumb": "http://site.dev:8080/default/thumb.jpg",
  "templates": {
    "archive": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/archive.ftl",
        "type": "archive"
      }
    ],
    "section": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/section.ftl",
        "type": "section"
      }
    ],
    "error": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/error.ftl",
        "type": "error"
      }
    ],
    "article": [
      {
        "name": "amp",
        "resource": "http://site.dev:8080/default/templates/article-amp.ftl",
        "type": "article"
      },
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/article.ftl",
        "type": "article",
        "thumb": "http://site.dev:8080/default/templates/article.jpg"
      }
    ],
    "search": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/search.ftl",
        "type": "search"
      }
    ],
    "site": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/site.ftl",
        "type": "site",
        "thumb": "http://site.dev:8080/default/templates/site.jpg"
      }
    ],
    "searchSidebar": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/searchSidebar.ftl",
        "type": "searchSidebar"
      }
    ],
    "sidebar": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/sidebar.ftl",
        "type": "sidebar"
      }
    ],
    "registration": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/registration.ftl",
        "type": "registration"
      }
    ],
    "styles": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/styles.ftl",
        "type": "styles"
      }
    ],
    "tag": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/tag.ftl",
        "type": "tag"
      }
    ],
    "scripts": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/scripts.ftl",
        "type": "scripts"
      }
    ],
    "verification": [
      {
        "name": "default",
        "resource": "http://site.dev:8080/default/templates/verification.ftl",
        "type": "verification"
      }
    ]
  },
  "variants": [
    {
      "name": "default",
      "resource": "http://site.dev:8080/assets/themes/default/css/default.css",
      "thumb": "http://site.dev:8080/assets/themes/default/css/default.jpg"
    }
  ],
  "lastModified": 0
}

STATUS CODES

Code Description

404

if no theme corresponding to the provided name can be found.

Menus

v.3.2019.05.p2

Retrieves menus created on the website.

API

GET

/menus

Retrieves all the menus on this website.

GET

/menus/{name}

Retrieves a menu.

Get menus - /menus

v.3.2019.05.p2

Retrieves all the menus on this website.

RESOURCE URL

GET /menus

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

REQUEST

example

GET /api/menus HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
    "myHomePageMenu" : {
        "name": "myHomepageMenu",
        "description": "A menu for my homepage",
        "items": [{
            "name": "Main",
            "label": "Item 1",
            "type" : "GROUP",
            "items": [{
                "label": "My Section",
                "items": [],
                "type" : "SECTION",
                "ref" : "4000-044da040fe02-ff804890f74b-0003"
            },
            {
                "label": "My External Link",
                "items": [],
                "type" : "EXTERNAL",
                "url" : "http://my.external.link"
            }]
        }]
    },
    "mySportSectionMenu" : {
        "name": "mySportSectionMenu",
        "description": "A menu for my sport section",
        "items": [{
            "label": "My rugby link",
            "items": [],
            "type" : "EXTERNAL",
            "url" : "http://my.rugby.external.link"
        },
        {
            "label": "My soccer link",
            "items": [],
            "type" : "EXTERNAL",
            "url" : "http://my.soccer.external.link"
        }]
    }
}

Get menu - /menus/{name}

v.3.2019.05.p2

Retrieves a menu.

RESOURCE URL

GET /menus/{name}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

PATH PARAMETERS

Parameter Required Default Description

name String

Yes

-

REQUEST

example

GET /api/menus/myHomepageMenu HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example

{
    "name": "myHomepageMenu",
    "description": "A menu for my homepage",
    "items": [{
        "name": "Main",
        "label": "Item 1",
        "type" : "GROUP",
        "items": [{
            "label": "My Section",
            "items": [],
            "type" : "SECTION",
            "ref" : "4000-044da040fe02-ff804890f74b-0003"
        },
        {
            "label": "My External Link",
            "items": [],
            "type" : "EXTERNAL",
            "url" : "http://my.external.link"
        }]
    }]
}

Urls

v.3.2019.05.p2

Methods to access urls data.

API

GET

/urls

GET

/urls/{id}

GET

/urls/foreignid/{foreignId}

GET

/urls/list

List url for node id

GET

/urls/resolve

Resolve url into a content id.

/urls/list

v.3.2019.05.p2

List url for node id

RESOURCE URL

GET /urls/list

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

id CobaltId

Yes

-

REQUEST

RESPONSE

Content type

application/json

/urls/foreignid/{foreignId}

v.3.2019.05.p2

RESOURCE URL

GET /urls/foreignid/{foreignId}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

format String

Yes

-

page Integer

Yes

-

siteName String

Yes

-

view String

Yes

-

resolutionType ResolutionType

No

RESOURCE

-

urlIntent UrlIntent

No

ABSOLUTE

-

viewStatus ViewStatus

No

LIVE

-

PATH PARAMETERS

Parameter Required Default Description

foreignId String

Yes

-

REQUEST

RESPONSE

Content type

application/json

/urls/{id}

v.3.2019.05.p2

RESOURCE URL

GET /urls/{id}

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

format String

Yes

-

page Integer

Yes

-

siteName String

Yes

-

view String

Yes

-

resolutionType ResolutionType

No

RESOURCE

-

urlIntent UrlIntent

No

ABSOLUTE

-

viewStatus ViewStatus

No

LIVE

-

PATH PARAMETERS

Parameter Required Default Description

id CobaltId

Yes

-

REQUEST

RESPONSE

Content type

application/json

/urls

v.3.2019.05.p2

RESOURCE URL

GET /urls

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

grep String

Yes

-

limit int

No

20

-

offset int

No

0

-

REQUEST

RESPONSE

Content type

application/json

/urls/resolve

v.3.2019.05.p2

Resolve url into a content id.

RESOURCE URL

GET /urls/resolve

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

url String

Yes

-

REQUEST

RESPONSE

Content type

application/json

Live Blogs

v.3.2019.05.p2

Methods to retrieve posts on Live Blogs.

API

GET

/liveblogs/{id}/posts

List posts for a live blog.

GET

/liveblogs/{id}/updates

Return posts updates for the given live blog.

Live Posts Update - /liveblogs/{id}/updates

v.3.2019.05.p2

Return posts updates for the given live blog.

RESOURCE URL

GET /liveblogs/{id}/updates

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

timestamp String

Yes

this parameter has been deprecated, use version instead

version String

Yes

the version of the live blog (or the version returned from this api call)

renderHtml boolean

No

true

if false the returned posts won’t be processed with the template engine, by default this is true and the produced html is available within extra.html field

template String

No

force template used in the rendering phase (required renderHtml to true)

PATH PARAMETERS

Parameter Required Default Description

id NodeId

Yes

the id of the live blog

REQUEST

example

GET /api/liveblogs/0250-0c37273345bb-a55953b9603b-1012/updates?version=0250-0c37273345bb-a55953b9603b-1012-134310234260 HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example - limit to a single post

{
    "count": 3,
    "result": [
        {
            "operation": "add",
            "post": {
                "dataType": "node",
                "id": "0250-0c372856c4bf-5e863b695e34-10ff",
                "version": "0250-0c372856c4bf-5e863b695e34-10ff-134310395316",
                "timestamp": "2019-04-04T12:26:35.316Z",
                "foreignId": "76cc845a-55d4-11e9-b2b7-a0fe99940c51",
                "title": "Test 3",
                "description": "",
                "authors": [],
                "sys": {
                    "kind": "content",
                    "baseType": "liveblogpost",
                    "type": "text",
                    "creationTime": "2019-04-04T12:26:35.316Z",
                    "createdBy": {
                        "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                        "userName": "alessandro.bertacco"
                    },
                    "updateTime": "2019-04-04T12:26:35.316Z",
                    "updatedBy": {
                        "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                        "userName": "alessandro.bertacco"
                    }
                },
                "pubInfo": {
                    "siteName": "test-site",
                    "status": "LIVE",
                    "publicationTime": "2019-04-04T12:26:35.316Z",
                    "publishedBy": {
                        "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                        "userName": "alessandro.bertacco"
                    },
                    "attributes": {
                        "pubDate": "2019-04-04T12:23:23.911Z",
                        "lastModified": "2019-04-03T05:47:49.000Z",
                        "sha1Content": "g1bjzjHJWQMZ6YZXKxfTuH3Kxd8",
                        "sha1Correlations": "2jmj7l5rSw0yVb\/vlWAYkK\/YBwk",
                        "primary": true,
                        "agent": "cobaltpub",
                        "path": "\/Cobalt\/test-site\/Stories\/test-lb1.emlive",
                        "eomDbid": "41",
                        "publicationId": "1da9a051-3ad0-443c-9c83-8e2e1d89bdd8"
                    },
                    "sectionPath": "\/",
                    "visible": true
                },
                "attributes": {
                    "tags": [],
                    "notes": "",
                    "liveblogpost": {
                        "type": "text",
                        "subject": "",
                        "status": "APPROVED",
                        "eventTime": "1554380791885"
                    },
                    "creator": "eom:alessandro.bertacco",
                    "created": "2019-04-03T05:51:02.000Z",
                    "last_modifier": "eom:alessandro.bertacco",
                    "modified": "2019-04-03T05:51:05.000Z",
                    "eventTime": "2019-04-04T12:26:31.885Z"
                },
                "files": {
                    "content": {
                        "fileName": "content.emlivepost",
                        "mimeType": "text\/xml",
                        "updatedBy": {
                            "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                            "userName": "alessandro.bertacco"
                        },
                        "updateTime": "2019-04-04T12:26:35.316Z",
                        "size": 92,
                        "data": "<article><h1>Test 3<\/h1><p><p><br\/><\/p><\/p><\/article>"
                    }
                },
                "pubInfoEx": {
                    "test-site": {
                        "siteName": "test-site",
                        "status": "LIVE",
                        "publicationTime": "2019-04-04T12:26:35.316Z",
                        "publishedBy": {
                            "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                            "userName": "alessandro.bertacco"
                        },
                        "attributes": {
                            "pubDate": "2019-04-04T12:23:23.911Z",
                            "lastModified": "2019-04-03T05:47:49.000Z",
                            "sha1Content": "g1bjzjHJWQMZ6YZXKxfTuH3Kxd8",
                            "sha1Correlations": "2jmj7l5rSw0yVb\/vlWAYkK\/YBwk",
                            "primary": true,
                            "agent": "cobaltpub",
                            "path": "\/Cobalt\/test-site\/Stories\/test-lb1.emlive",
                            "eomDbid": "41",
                            "publicationId": "1da9a051-3ad0-443c-9c83-8e2e1d89bdd8"
                        },
                        "liveInfo": {
                            "version": "0250-0c372856c4bf-5e863b695e34-10ff-134310395316",
                            "sourceVersion": "0250-0c372856c4bf-5e863b695e34-10ff-n134310204885",
                            "publicationTime": "2019-04-04T12:26:35.316Z",
                            "publishedBy": {
                                "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                                "userName": "alessandro.bertacco"
                            }
                        },
                        "stageInfo": {
                            "version": "0250-0c372856c4bf-5e863b695e34-10ff-n134310204885",
                            "publicationTime": "2019-04-04T12:23:24.885Z",
                            "publishedBy": {
                                "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                                "userName": "alessandro.bertacco"
                            }
                        },
                        "previewInfo": {
                            "version": "0250-0c372856c4bf-5e863b695e34-10ff-n134310204885",
                            "publicationTime": "2019-04-04T12:23:24.885Z",
                            "publishedBy": {
                                "userId": "7d850632-95e8-4a6c-bf32-df9bf2b1473c",
                                "userName": "alessandro.bertacco"
                            }
                        },
                        "sectionPath": "\/",
                        "visible": true
                    }
                },
                "extra": {
                    "html": "\n\t\t<article id=\"0250-0c372856c4bf-5e863b695e34-10ff\">\n\t\t\t<aside>\n\t\t\t<time datetime=\"2019-04-04T12:26:31Z\"><div class=\"date\">Apr 4,<br>02:26 PM<\/div><\/time>\n\t\t\t<\/aside>\n\t\t\t<header>\n\t\t\t\t<img src=\"http:\/\/10.200.10.1:8480\/directory\/users\/picture?id=7d850632-95e8-4a6c-bf32-df9bf2b1473c\"\/>\n\t\t\t\t<address>alessandro.bertacco<\/address>\n\t\t\t\t\t<h3>Test 3<\/h3>\n\t\t\t<\/header>\n\n\t\t\t<p>\n    <p><\/p>\n<\/p>\n\n\n<!--\n{\n  \"dataType\" : \"node\",\n  \"id\" : \"0250-0c372856c4bf-5e863b695e34-10ff\",\n  \"version\" : \"0250-0c372856c4bf-5e863b695e34-10ff-134310395316\",\n  \"timestamp\" : \"2019-04-04T12:26:35.316Z\",\n  \"foreignId\" : \"76cc845a-55d4-11e9-b2b7-a0fe99940c51\",\n  \"title\" : \"Test 3\",\n  \"description\" : \"\",\n  \"authors\" : [ ],\n  \"sys\" : {\n    \"kind\" : \"content\",\n    \"baseType\" : \"liveblogpost\",\n    \"type\" : \"text\",\n    \"creationTime\" : \"2019-04-04T12:26:35.316Z\",\n    \"createdBy\" : {\n      \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n      \"userName\" : \"alessandro.bertacco\"\n    },\n    \"updateTime\" : \"2019-04-04T12:26:35.316Z\",\n    \"updatedBy\" : {\n      \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n      \"userName\" : \"alessandro.bertacco\"\n    }\n  },\n  \"pubInfo\" : {\n    \"siteName\" : \"test-site\",\n    \"status\" : \"LIVE\",\n    \"publicationTime\" : \"2019-04-04T12:26:35.316Z\",\n    \"publishedBy\" : {\n      \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n      \"userName\" : \"alessandro.bertacco\"\n    },\n    \"attributes\" : {\n      \"pubDate\" : \"2019-04-04T12:23:23.911Z\",\n      \"lastModified\" : \"2019-04-03T05:47:49.000Z\",\n      \"sha1Content\" : \"g1bjzjHJWQMZ6YZXKxfTuH3Kxd8\",\n      \"sha1Correlations\" : \"2jmj7l5rSw0yVb\/vlWAYkK\/YBwk\",\n      \"primary\" : true,\n      \"agent\" : \"cobaltpub\",\n      \"path\" : \"\/Cobalt\/test-site\/Stories\/test-lb1.emlive\",\n      \"eomDbid\" : \"41\",\n      \"publicationId\" : \"1da9a051-3ad0-443c-9c83-8e2e1d89bdd8\"\n    },\n    \"sectionPath\" : \"\/\",\n    \"visible\" : true\n  },\n  \"attributes\" : {\n    \"tags\" : [ ],\n    \"notes\" : \"\",\n    \"liveblogpost\" : {\n      \"type\" : \"text\",\n      \"subject\" : \"\",\n      \"status\" : \"APPROVED\",\n      \"eventTime\" : \"1554380791885\"\n    },\n    \"creator\" : \"eom:alessandro.bertacco\",\n    \"created\" : \"2019-04-03T05:51:02.000Z\",\n    \"last_modifier\" : \"eom:alessandro.bertacco\",\n    \"modified\" : \"2019-04-03T05:51:05.000Z\",\n    \"eventTime\" : \"2019-04-04T12:26:31.885Z\"\n  },\n  \"files\" : {\n    \"content\" : {\n      \"fileName\" : \"content.emlivepost\",\n      \"mimeType\" : \"text\/xml\",\n      \"updatedBy\" : {\n        \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n        \"userName\" : \"alessandro.bertacco\"\n      },\n      \"updateTime\" : \"2019-04-04T12:26:35.316Z\",\n      \"size\" : 92,\n      \"data\" : \"<article><h1>Test 3<\/h1><p><p><br\/><\/p><\/p><\/article>\"\n    }\n  },\n  \"pubInfoEx\" : {\n    \"test-site\" : {\n      \"siteName\" : \"test-site\",\n      \"status\" : \"LIVE\",\n      \"publicationTime\" : \"2019-04-04T12:26:35.316Z\",\n      \"publishedBy\" : {\n        \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n        \"userName\" : \"alessandro.bertacco\"\n      },\n      \"attributes\" : {\n        \"pubDate\" : \"2019-04-04T12:23:23.911Z\",\n        \"lastModified\" : \"2019-04-03T05:47:49.000Z\",\n        \"sha1Content\" : \"g1bjzjHJWQMZ6YZXKxfTuH3Kxd8\",\n        \"sha1Correlations\" : \"2jmj7l5rSw0yVb\/vlWAYkK\/YBwk\",\n        \"primary\" : true,\n        \"agent\" : \"cobaltpub\",\n        \"path\" : \"\/Cobalt\/test-site\/Stories\/test-lb1.emlive\",\n        \"eomDbid\" : \"41\",\n        \"publicationId\" : \"1da9a051-3ad0-443c-9c83-8e2e1d89bdd8\"\n      },\n      \"liveInfo\" : {\n        \"version\" : \"0250-0c372856c4bf-5e863b695e34-10ff-134310395316\",\n        \"sourceVersion\" : \"0250-0c372856c4bf-5e863b695e34-10ff-n134310204885\",\n        \"publicationTime\" : \"2019-04-04T12:26:35.316Z\",\n        \"publishedBy\" : {\n          \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n          \"userName\" : \"alessandro.bertacco\"\n        }\n      },\n      \"stageInfo\" : {\n        \"version\" : \"0250-0c372856c4bf-5e863b695e34-10ff-n134310204885\",\n        \"publicationTime\" : \"2019-04-04T12:23:24.885Z\",\n        \"publishedBy\" : {\n          \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n          \"userName\" : \"alessandro.bertacco\"\n        }\n      },\n      \"previewInfo\" : {\n        \"version\" : \"0250-0c372856c4bf-5e863b695e34-10ff-n134310204885\",\n        \"publicationTime\" : \"2019-04-04T12:23:24.885Z\",\n        \"publishedBy\" : {\n          \"userId\" : \"7d850632-95e8-4a6c-bf32-df9bf2b1473c\",\n          \"userName\" : \"alessandro.bertacco\"\n        }\n      },\n      \"sectionPath\" : \"\/\",\n      \"visible\" : true\n    }\n  },\n  \"etag\" : \"0250-0c372856c4bf-5e863b695e34-10ff-134310395316\",\n  \"dataType\" : \"node\",\n  \"contentLength\" : 0,\n  \"lastModified\" : 1554380795316\n}\n-->\n\n\t\t<\/article>"
                },
                "etag": "0250-0c372856c4bf-5e863b695e34-10ff-134310395316",
                "contentLength": 0,
                "lastModified": 1554380795316
            }
        }
    ],
    "version": "0250-0c37273345bb-a55953b9603b-1012-134310395316",
    "reset": false
}

STATUS CODES

Code Description

404

if the live blog id is not related to a valid live blog

List Posts - /liveblogs/{id}/posts

v.3.2019.05.p2

List posts for a live blog.

RESOURCE URL

GET /liveblogs/{id}/posts

RESOURCE INFORMATION

Beta

No

Authentication Required

Yes

QUERY PARAMETERS

Parameter Required Default Description

template String

Yes

(option) Force template for the live blog

from NodeId

No

NodeId of the starting posts

limit int

No

10

Number of posts to load

renderHtml boolean

No

true

Render html for the posts

PATH PARAMETERS

Parameter Required Default Description

id NodeId

Yes

Node id of the live blog

REQUEST

example - starts posts from a specific one and limit to a single post

GET /api/liveblogs/0238-068f01514b02-855fa2f33533-1012/posts?from=0238-068f01583851-5de8671f139d-10ff&limit=1 HTTP/1.1
Host: site.dev

example - render html and force a different template

GET /api/liveblogs/0238-068f01514b02-855fa2f33533-1012/posts?renderHtml=true&template=custom HTTP/1.1
Host: site.dev

RESPONSE

Content type

application/json

example - limit to a single post

{
  "count" : 1,
  "result" : [ {
    "dataType" : "node",
    "id" : "0238-068f01583851-5de8671f139d-10ff",
    "version" : "0238-068f01583851-5de8671f139d-10ff-72112726459",
    "timestamp" : "2017-04-14T15:18:46.487Z",
    "foreignId" : "bb039526-2d15-407d-957b-0b6c5c5e9de2",
    "title" : "Live Blog Post bb039526-2d15-407d-957b-0b6c5c5e9de2",
    "sys" : {
      "kind" : "content",
      "baseType" : "liveblogpost",
      "type" : "text",
      "creationTime" : "2017-04-14T15:18:46.483Z",
      "createdBy" : {
        "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
        "userName" : "admin"
      },
      "updateTime" : "2017-04-14T15:18:46.487Z",
      "updatedBy" : {
        "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
        "userName" : "admin"
      }
    },
    "pubInfo" : {
      "siteName" : "matteo",
      "status" : "LIVE",
      "publicationTime" : "2017-04-14T15:18:46.459Z",
      "publishedBy" : {
        "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
        "userName" : "admin"
      },
      "sectionPath" : "/",
      "embargoVisible" : true
    },
    "attributes" : {
      "tags" : [ ]
    },
    "files" : {
      "content" : {
        "fileName" : "text.xml",
        "mimeType" : "text/xml",
        "updatedBy" : {
          "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
          "userName" : "admin"
        },
        "updateTime" : "2017-04-14T15:18:46.487Z",
        "size" : 741,
        "data" : "<?xml version='1.0'?><article type=\"liveblog-post-text\">\n    <h1>\n        Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n    </h1>\n    <p>\n        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris vel dictum massa.\n        Praesent sapien enim, <strong>tristique a sapien</strong> neque. Donec augue\n        ante, blandit mattis auctor sed, elementum quis purus. Curabitur condimentum aliquam\n        risus, in accumsan enim accumsan ut. In blandit, <i>dolor nec</i> ornare tempor, \n        ante congue arcu, sit amet <u>gravida lorem quam quis magna</u>. Praesent ultricies\n        dignissim mi at lobortis. Maecenas pretium enim sit amet tortor tincidunt porta.\n        Fusce aliquet diam eget arcu pretium placerat.\n    </p>\n</article>"
      }
    },
    "pubInfoEx" : {
      "matteo" : {
        "siteName" : "matteo",
        "status" : "LIVE",
        "publicationTime" : "2017-04-14T15:18:42.527Z",
        "publishedBy" : {
          "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
          "userName" : "admin"
        },
        "liveInfo" : {
          "version" : "0238-068f01583851-5de8671f139d-10ff-72112726459",
          "sourceVersion" : "0238-068f01583851-5de8671f139d-10ff-n72112722527",
          "publicationTime" : "2017-04-14T15:18:46.459Z",
          "publishedBy" : {
            "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
            "userName" : "admin"
          }
        },
        "stageInfo" : {
          "version" : "0238-068f01583851-5de8671f139d-10ff-n72112722527",
          "publicationTime" : "2017-04-14T15:18:42.527Z",
          "publishedBy" : {
            "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
            "userName" : "admin"
          }
        },
        "previewInfo" : {
          "version" : "0238-068f01583851-5de8671f139d-10ff-n72112722527",
          "publishedBy" : {
            "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
            "userName" : "admin"
          }
        },
        "sectionPath" : "/",
        "embargoVisible" : true
      }
    },
    "extra" : {
      "html" : "<article type=\"liveblog-post-text\">\n    \n    <h1>\n        Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n    </h1>\n    \n    <p>\n        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris vel dictum massa.\n        Praesent sapien enim, <strong>tristique a sapien</strong> neque. Donec augue\n        ante, blandit mattis auctor sed, elementum quis purus. Curabitur condimentum aliquam\n        risus, in accumsan enim accumsan ut. In blandit, <i>dolor nec</i> ornare tempor, \n        ante congue arcu, sit amet <u>gravida lorem quam quis magna</u>. Praesent ultricies\n        dignissim mi at lobortis. Maecenas pretium enim sit amet tortor tincidunt porta.\n        Fusce aliquet diam eget arcu pretium placerat.\n    </p>\n\n</article>\n"
    },
    "contentLength" : 0,
    "lastModified" : 1492183126487,
    "etag" : "0238-068f01583851-5de8671f139d-10ff-72112726459"
  }],
  "parent" : {
    "dataType" : "node",
    "id" : "0238-068f01514b02-855fa2f33533-1012",
    "version" : "0238-068f01514b02-855fa2f33533-1012-72112726459",
    "timestamp" : "2017-04-14T15:18:46.459Z",
    "foreignId" : "e2f15d13-2561-4cf1-ad69-a117914d5955",
    "title" : "Test publish e2f15d13-2561-4cf1-ad69-a117914d5955",
    "sys" : {
      "kind" : "content",
      "baseType" : "liveblog",
      "type" : "liveblog",
      "creationTime" : "2017-04-14T15:18:41.948Z",
      "createdBy" : {
        "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
        "userName" : "admin"
      },
      "updateTime" : "2017-04-14T15:18:46.459Z",
      "updatedBy" : {
        "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
        "userName" : "admin"
      }
    },
    "pubInfo" : {
      "siteName" : "matteo",
      "status" : "LIVE",
      "publicationTime" : "2017-04-14T15:18:46.459Z",
      "publishedBy" : {
        "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
        "userName" : "admin"
      },
      "sectionPath" : "/",
      "embargoVisible" : true
    },
    "attributes" : {
      "template" : "sport",
      "tags" : [ ]
    },
    "files" : {
      "content" : {
        "fileName" : "liveblog.xml",
        "mimeType" : "application/xml",
        "updatedBy" : {
          "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
          "userName" : "admin"
        },
        "updateTime" : "2017-04-14T15:18:42.471Z",
        "size" : 5042,
        "data" : "..."
      }
    },
    "pubInfoEx" : {
      "matteo" : {
        "siteName" : "matteo",
        "status" : "LIVE",
        "publicationTime" : "2017-04-14T15:18:42.527Z",
        "publishedBy" : {
          "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
          "userName" : "admin"
        },
        "liveInfo" : {
          "version" : "0238-068f01514b02-855fa2f33533-1012-72112726459",
          "sourceVersion" : "0238-068f01514b02-855fa2f33533-1012-n72112722527",
          "publicationTime" : "2017-04-14T15:18:46.459Z",
          "publishedBy" : {
            "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
            "userName" : "admin"
          }
        },
        "stageInfo" : {
          "version" : "0238-068f01514b02-855fa2f33533-1012-n72112722527",
          "publicationTime" : "2017-04-14T15:18:42.527Z",
          "publishedBy" : {
            "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
            "userName" : "admin"
          }
        },
        "previewInfo" : {
          "version" : "0238-068f01514b02-855fa2f33533-1012-n72112722527",
          "publishedBy" : {
            "userId" : "e0b8011e-655f-4e41-8ac3-fadececd376f",
            "userName" : "admin"
          }
        },
        "sectionPath" : "/",
        "embargoVisible" : true
      }
    },
    "children" : [ "0238-068f01583851-5de8671f139d-10ff", "0238-068f0157d28c-30d709878667-10ff", "0238-068f015767de-07ccf9ce6854-10ff", "0238-068f0156edfb-dbe1f4061d44-10ff", "0238-068f0156725e-1acfa726219e-10ff", "0238-068f01560655-eb4a8954ba2b-10ff", "0238-068f0155a1ca-fa5d6427f618-10ff", "0238-068f01553ef2-6ff3040cf51b-10ff", "0238-068f0154e2bc-df7fea603100-10ff", "0238-068f01547d0c-47dd1ed70286-10ff" ],
    "contentLength" : 0,
    "lastModified" : 1492183126459,
    "etag" : "0238-068f01514b02-855fa2f33533-1012-72112726459"
  }
}

STATUS CODES

Code Description

404

if no site corresponding to the requested hostname can be found.