GET /V1/cmsPage/{pageId}

Retrieve page.

Path parameters

  • pageId integer Required

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • id integer

      ID

    • identifier string Required

      Identifier

    • title string

      Title

    • page_layout string

      Page layout

    • meta_title string

      Meta title

    • meta_keywords string

      Meta keywords

    • meta_description string

      Meta description

    • content_heading string

      Content heading

    • content string

      Content

    • creation_time string

      Creation time

    • update_time string

      Update time

    • sort_order string

      Sort order

    • layout_update_xml string

      Layout update xml

    • custom_theme string

      Custom theme

    • custom_root_template string

      Custom root template

    • custom_layout_update_xml string

      Custom layout update xml

    • custom_theme_from string

      Custom theme from

    • custom_theme_to string

      Custom theme to

    • active boolean

      Active

    Hide response attributes Show response attributes object
    • id integer

      ID

    • identifier string Required

      Identifier

    • title string

      Title

    • page_layout string

      Page layout

    • meta_title string

      Meta title

    • meta_keywords string

      Meta keywords

    • meta_description string

      Meta description

    • content_heading string

      Content heading

    • content string

      Content

    • creation_time string

      Creation time

    • update_time string

      Update time

    • sort_order string

      Sort order

    • layout_update_xml string

      Layout update xml

    • custom_theme string

      Custom theme

    • custom_root_template string

      Custom root template

    • custom_layout_update_xml string

      Custom layout update xml

    • custom_theme_from string

      Custom theme from

    • custom_theme_to string

      Custom theme to

    • active boolean

      Active

  • Internal Server error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/cmsPage/{pageId}
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/cmsPage/{pageId}'
Response examples (200)
{
  "id": 42,
  "identifier": "string",
  "title": "string",
  "page_layout": "string",
  "meta_title": "string",
  "meta_keywords": "string",
  "meta_description": "string",
  "content_heading": "string",
  "content": "string",
  "creation_time": "string",
  "update_time": "string",
  "sort_order": "string",
  "layout_update_xml": "string",
  "custom_theme": "string",
  "custom_root_template": "string",
  "custom_layout_update_xml": "string",
  "custom_theme_from": "string",
  "custom_theme_to": "string",
  "active": true
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <id type="integer">42</id>
  <identifier>string</identifier>
  <title>string</title>
  <page-layout>string</page-layout>
  <meta-title>string</meta-title>
  <meta-keywords>string</meta-keywords>
  <meta-description>string</meta-description>
  <content-heading>string</content-heading>
  <content>string</content>
  <creation-time>string</creation-time>
  <update-time>string</update-time>
  <sort-order>string</sort-order>
  <layout-update-xml>string</layout-update-xml>
  <custom-theme>string</custom-theme>
  <custom-root-template>string</custom-root-template>
  <custom-layout-update-xml>string</custom-layout-update-xml>
  <custom-theme-from>string</custom-theme-from>
  <custom-theme-to>string</custom-theme-to>
  <active type="boolean">true</active>
</root>
Response examples (500)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (500)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>