CMS SmartEdit Webservices

These enhanced services manage CMS-related items specifically designed for SmartEdit.
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0
BasePath:/cmssmarteditwebservices
Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. OAuth AuthorizationUrl:TokenUrl:https://{oauth2_url}/authorizationserver/oauth/token
  2. OAuth AuthorizationUrl:TokenUrl:https://{oauth2_url}/authorizationserver/oauth/token

Methods

[ Jump to Models ]

Table of Contents

Catalogs

Categories

Inbox

PageComponentTypes

PageOperations

Products

Synchronizations

Workflows

Catalogs

Up 
get /v1/sites/{baseSiteId}/contentcatalogs
Get content catalogs (getContentCatalogs)
Endpoint to retrieve content catalog information including the related catalog versions for all catalogs for a given site.

Path parameters

baseSiteId (required)
Path Parameter — The site identifier

Return type

CatalogListData

Example data

Content-Type: application/json
{
  "catalogs" : [ {
    "catalogId" : "catalogId",
    "versions" : [ {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    }, {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    } ],
    "name" : {
      "key" : "name"
    }
  }, {
    "catalogId" : "catalogId",
    "versions" : [ {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    }, {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    } ],
    "name" : {
      "key" : "name"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CatalogListData

401

Must be authenticated as an Admin or CMS Manager to access this resource
Up 
get /v1/sites/{baseSiteId}/productcatalogs
Get product catalogs (getProductCatalogs)
Endpoint to retrieve product catalog information including the related catalog versions for all catalogs for a given site

Path parameters

baseSiteId (required)
Path Parameter — The site identifier

Return type

CatalogListData

Example data

Content-Type: application/json
{
  "catalogs" : [ {
    "catalogId" : "catalogId",
    "versions" : [ {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    }, {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    } ],
    "name" : {
      "key" : "name"
    }
  }, {
    "catalogId" : "catalogId",
    "versions" : [ {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    }, {
      "pageDisplayConditions" : [ {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      }, {
        "typecode" : "typecode",
        "options" : [ {
          "id" : "id",
          "label" : "label"
        }, {
          "id" : "id",
          "label" : "label"
        } ]
      } ],
      "active" : true,
      "uuid" : "uuid",
      "version" : "version",
      "homepage" : {
        "current" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "old" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        },
        "fallback" : {
          "catalogVersionUuid" : "catalogVersionUuid",
          "template" : "template",
          "defaultPage" : true,
          "cloneComponents" : true,
          "restrictions" : [ "restrictions", "restrictions" ],
          "title" : {
            "key" : "title"
          },
          "typeCode" : "typeCode",
          "uid" : "uid",
          "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
          "onlyOneRestrictionMustApply" : true,
          "name" : "name",
          "creationtime" : "2000-01-23T04:56:07.000+00:00",
          "pk" : "pk"
        }
      },
      "thumbnailUrl" : "thumbnailUrl"
    } ],
    "name" : {
      "key" : "name"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CatalogListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

Categories

Up 
get /v1/productcatalogs/{catalogId}/versions/{versionId}/categories
Find product categories by text or mask (findProductCategoriesByTextOrMask)
Endpoint to find product categories using a free text search field.

Path parameters

catalogId (required)
Path Parameter — The uid of the catalog
versionId (required)
Path Parameter — The uid of the catalog version

Query parameters

currentPage (optional)
Query Parameter — The requested page number default: 0
langIsoCode (optional)
Query Parameter — The language iso code used to filter products
mask (optional)
Query Parameter — The string value on which products will be filtered if no text value is provided
pageSize (optional)
Query Parameter — The maximum number of elements in the result list. default: 10
sort (optional)
Query Parameter — The string field the results will be sorted with
text (optional)
Query Parameter — The string value on which products will be filtered

Return type

CategorySearchResultData

Example data

Content-Type: application/json
{
  "productCategories" : [ {
    "catalogVersion" : "catalogVersion",
    "uid" : "uid",
    "thumbnail" : {
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "code" : "code",
      "altText" : "altText",
      "mime" : "mime",
      "downloadUrl" : "downloadUrl",
      "description" : "description",
      "url" : "url"
    },
    "catalogId" : "catalogId",
    "code" : "code",
    "name" : {
      "key" : "name"
    },
    "description" : {
      "key" : "description"
    }
  }, {
    "catalogVersion" : "catalogVersion",
    "uid" : "uid",
    "thumbnail" : {
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "code" : "code",
      "altText" : "altText",
      "mime" : "mime",
      "downloadUrl" : "downloadUrl",
      "description" : "description",
      "url" : "url"
    },
    "catalogId" : "catalogId",
    "code" : "code",
    "name" : {
      "key" : "name"
    },
    "description" : {
      "key" : "description"
    }
  } ],
  "pagination" : {
    "count" : 0,
    "totalPages" : 5,
    "hasPrevious" : true,
    "hasNext" : true,
    "page" : 6,
    "totalCount" : 1
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

item which serves as a wrapper object that contains a list of CategoryData, never null CategorySearchResultData

400

Bad Request e.g. incorrect parameter value

401

Must be authenticated as an Admin or CMS Manager to access this resource
Up 
get /v1/sites/{baseSiteId}/categories/{code}
Get category by code (uuid) (getCategoryByCode)
Endpoint to retrieve a category that matches the given product category code uuid.

Path parameters

baseSiteId (required)
Path Parameter — Base site identifier
code (required)
Path Parameter — Category code (uuid)

Return type

CategoryData

Example data

Content-Type: application/json
{
  "catalogVersion" : "catalogVersion",
  "uid" : "uid",
  "thumbnail" : {
    "catalogVersion" : "catalogVersion",
    "catalogId" : "catalogId",
    "code" : "code",
    "altText" : "altText",
    "mime" : "mime",
    "downloadUrl" : "downloadUrl",
    "description" : "description",
    "url" : "url"
  },
  "catalogId" : "catalogId",
  "code" : "code",
  "name" : {
    "key" : "name"
  },
  "description" : {
    "key" : "description"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Category data CategoryData

400

When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).

401

Must be authenticated as an Admin or CMS Manager to access this resource

Inbox

Up 
get /v1/inbox/workflowtasks
Retrieves all workflow tasks for the current user that are yet to be acted upon (getWorkflowTasks)
Endpoint that retrieves all workflow tasks for the current user

Query parameters

currentPage (optional)
Query Parameter — The requested page number default: 0
pageSize (optional)
Query Parameter — The maximum number of elements in the result list. default: 10
sort (optional)
Query Parameter — The string field the results will be sorted with

Return type

CMSWorkflowTaskListData

Example data

Content-Type: application/json
{
  "pagination" : {
    "count" : 0,
    "totalPages" : 5,
    "hasPrevious" : true,
    "hasNext" : true,
    "page" : 6,
    "totalCount" : 1
  },
  "tasks" : [ {
    "attachments" : [ {
      "catalogName" : "catalogName",
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "pageUid" : "pageUid",
      "pageName" : "pageName"
    }, {
      "catalogName" : "catalogName",
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "pageUid" : "pageUid",
      "pageName" : "pageName"
    } ],
    "action" : {
      "isCurrentUserParticipant" : true,
      "code" : "code",
      "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "description" : "description",
      "startedAgoInMillis" : 0,
      "status" : "status"
    }
  }, {
    "attachments" : [ {
      "catalogName" : "catalogName",
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "pageUid" : "pageUid",
      "pageName" : "pageName"
    }, {
      "catalogName" : "catalogName",
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "pageUid" : "pageUid",
      "pageName" : "pageName"
    } ],
    "action" : {
      "isCurrentUserParticipant" : true,
      "code" : "code",
      "modifiedtime" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "description" : "description",
      "startedAgoInMillis" : 0,
      "status" : "status"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The item containing the workflow tasks CMSWorkflowTaskListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

PageComponentTypes

Up 
get /v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/types
Retrieves the component types applicable to a page. (getComponentTypesAvailableToPage)
Retrieves the component types that can be added to a page.

Path parameters

catalogId (required)
Path Parameter — The catalog id
pageId (required)
Path Parameter — The uid of the page for which to find its valid component types
versionId (required)
Path Parameter — The uid of the catalog version

Query parameters

currentPage (optional)
Query Parameter — The requested page number default: 0
fields (optional)
Query Parameter — Response configuration (list of fields, which should be returned in response) default: DEFAULT
mask (optional)
Query Parameter — Search mask applied to the type code and name fields, Uses partial matching
pageSize (required)
Query Parameter — Page size for paging
readOnly (optional)
Query Parameter — Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used) default: false

Return type

CMSComponentTypeListData

Example data

Content-Type: application/json
{
  "pagination" : {
    "count" : 0,
    "totalPages" : 5,
    "hasPrevious" : true,
    "hasNext" : true,
    "page" : 6,
    "totalCount" : 1
  },
  "componentTypes" : [ {
    "code" : "code",
    "i18nKey" : "i18nKey",
    "name" : "name",
    "attributes" : [ {
      "paged" : true,
      "dependsOn" : "dependsOn",
      "containedTypes" : [ "containedTypes", "containedTypes" ],
      "editable" : true,
      "localized" : true,
      "subTypes" : {
        "key" : "subTypes"
      },
      "collection" : true,
      "params" : {
        "key" : "params"
      },
      "uri" : "uri",
      "required" : true,
      "cmsStructureType" : "cmsStructureType",
      "i18nKey" : "i18nKey",
      "idAttribute" : "idAttribute",
      "qualifier" : "qualifier",
      "labelAttributes" : [ "labelAttributes", "labelAttributes" ],
      "options" : [ {
        "id" : "id",
        "label" : "label"
      }, {
        "id" : "id",
        "label" : "label"
      } ],
      "placeholder" : "placeholder",
      "cmsStructureEnumType" : "cmsStructureEnumType"
    }, {
      "paged" : true,
      "dependsOn" : "dependsOn",
      "containedTypes" : [ "containedTypes", "containedTypes" ],
      "editable" : true,
      "localized" : true,
      "subTypes" : {
        "key" : "subTypes"
      },
      "collection" : true,
      "params" : {
        "key" : "params"
      },
      "uri" : "uri",
      "required" : true,
      "cmsStructureType" : "cmsStructureType",
      "i18nKey" : "i18nKey",
      "idAttribute" : "idAttribute",
      "qualifier" : "qualifier",
      "labelAttributes" : [ "labelAttributes", "labelAttributes" ],
      "options" : [ {
        "id" : "id",
        "label" : "label"
      }, {
        "id" : "id",
        "label" : "label"
      } ],
      "placeholder" : "placeholder",
      "cmsStructureEnumType" : "cmsStructureEnumType"
    } ],
    "category" : "category",
    "type" : "type"
  }, {
    "code" : "code",
    "i18nKey" : "i18nKey",
    "name" : "name",
    "attributes" : [ {
      "paged" : true,
      "dependsOn" : "dependsOn",
      "containedTypes" : [ "containedTypes", "containedTypes" ],
      "editable" : true,
      "localized" : true,
      "subTypes" : {
        "key" : "subTypes"
      },
      "collection" : true,
      "params" : {
        "key" : "params"
      },
      "uri" : "uri",
      "required" : true,
      "cmsStructureType" : "cmsStructureType",
      "i18nKey" : "i18nKey",
      "idAttribute" : "idAttribute",
      "qualifier" : "qualifier",
      "labelAttributes" : [ "labelAttributes", "labelAttributes" ],
      "options" : [ {
        "id" : "id",
        "label" : "label"
      }, {
        "id" : "id",
        "label" : "label"
      } ],
      "placeholder" : "placeholder",
      "cmsStructureEnumType" : "cmsStructureEnumType"
    }, {
      "paged" : true,
      "dependsOn" : "dependsOn",
      "containedTypes" : [ "containedTypes", "containedTypes" ],
      "editable" : true,
      "localized" : true,
      "subTypes" : {
        "key" : "subTypes"
      },
      "collection" : true,
      "params" : {
        "key" : "params"
      },
      "uri" : "uri",
      "required" : true,
      "cmsStructureType" : "cmsStructureType",
      "i18nKey" : "i18nKey",
      "idAttribute" : "idAttribute",
      "qualifier" : "qualifier",
      "labelAttributes" : [ "labelAttributes", "labelAttributes" ],
      "options" : [ {
        "id" : "id",
        "label" : "label"
      }, {
        "id" : "id",
        "label" : "label"
      } ],
      "placeholder" : "placeholder",
      "cmsStructureEnumType" : "cmsStructureEnumType"
    } ],
    "category" : "category",
    "type" : "type"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The item containing the list of component types applicable to a page. The results are paged. CMSComponentTypeListData

400

If the given page cannot be found (CMSItemNotFoundException).

401

Must be authenticated as an Admin or CMS Manager to access this resource

PageOperations

Up 
post /v1/sites/{baseSiteId}/catalogs/{catalogId}/pages/{pageId}/operations
Perform different operations on the page item. (perform)
Endpoint to perform different operations on the page item such as delete a page etc.

Path parameters

baseSiteId (required)
Path Parameter — Base site identifier
catalogId (required)
Path Parameter — The uid of the catalog
pageId (required)
Path Parameter — The uid of the page to be updated
pageUid (required)
Path Parameter — The uid of the page

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

operationData CMSPageOperationData (required)
Body Parameter — The item object containing all the information about operation to be performed

Return type

CMSPageOperationData

Example data

Content-Type: application/json
{
  "targetCatalogVersion" : "targetCatalogVersion",
  "catalogId" : "catalogId",
  "operation" : "operation",
  "sourceCatalogVersion" : "sourceCatalogVersion"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The page operation item. CMSPageOperationData

400

When the payload does not have the 'operation' property. (IllegalArgumentException)

401

Must be authenticated as an Admin or CMS Manager to access this resource

404

When the item has not been found (UnknownIdentifierException)

Products

Up 
get /v1/productcatalogs/{catalogId}/versions/{versionId}/products
Find products by text or mask (findProductsByTextOrMask)
Endpoint to retrieve products using a free text search field.

Path parameters

catalogId (required)
Path Parameter — The uid of the catalog
versionId (required)
Path Parameter — The uid of the catalog version

Query parameters

currentPage (optional)
Query Parameter — The requested page number default: 0
langIsoCode (optional)
Query Parameter — The language iso code by which products will be filtered
mask (optional)
Query Parameter — The string value on which products will be filtered if no text value is provided
pageSize (optional)
Query Parameter — The maximum number of elements in the result list. default: 10
sort (optional)
Query Parameter — The string field the results will be sorted with
text (optional)
Query Parameter — The string value on which products will be filtered

Return type

ProductSearchResultData

Example data

Content-Type: application/json
{
  "pagination" : {
    "count" : 0,
    "totalPages" : 5,
    "hasPrevious" : true,
    "hasNext" : true,
    "page" : 6,
    "totalCount" : 1
  },
  "products" : [ {
    "catalogVersion" : "catalogVersion",
    "uid" : "uid",
    "thumbnail" : {
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "code" : "code",
      "altText" : "altText",
      "mime" : "mime",
      "downloadUrl" : "downloadUrl",
      "description" : "description",
      "url" : "url"
    },
    "catalogId" : "catalogId",
    "code" : "code",
    "name" : {
      "key" : "name"
    },
    "description" : {
      "key" : "description"
    }
  }, {
    "catalogVersion" : "catalogVersion",
    "uid" : "uid",
    "thumbnail" : {
      "catalogVersion" : "catalogVersion",
      "catalogId" : "catalogId",
      "code" : "code",
      "altText" : "altText",
      "mime" : "mime",
      "downloadUrl" : "downloadUrl",
      "description" : "description",
      "url" : "url"
    },
    "catalogId" : "catalogId",
    "code" : "code",
    "name" : {
      "key" : "name"
    },
    "description" : {
      "key" : "description"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

item which serves as a wrapper object that contains a list of ProductData, never null ProductSearchResultData

401

Must be authenticated as an Admin or CMS Manager to access this resource
Up 
get /v1/sites/{baseSiteId}/products/{code}
Get product by code (uuid) (getProductByCode)
Endpoint to retrieve a product that matches the given product code uuid.

Path parameters

baseSiteId (required)
Path Parameter — Base site identifier
code (required)
Path Parameter — Product code (uuid)

Return type

ProductData

Example data

Content-Type: application/json
{
  "catalogVersion" : "catalogVersion",
  "uid" : "uid",
  "thumbnail" : {
    "catalogVersion" : "catalogVersion",
    "catalogId" : "catalogId",
    "code" : "code",
    "altText" : "altText",
    "mime" : "mime",
    "downloadUrl" : "downloadUrl",
    "description" : "description",
    "url" : "url"
  },
  "catalogId" : "catalogId",
  "code" : "code",
  "name" : {
    "key" : "name"
  },
  "description" : {
    "key" : "description"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Product data ProductData

400

When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).

401

Must be authenticated as an Admin or CMS Manager to access this resource

Synchronizations

Up 
get /v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/pages/{pageId}
Get synchronization status (getSyncStatus)
Will build the synchronization status of a page including detailed status of its content slots and their cms components.

Path parameters

baseSiteId (required)
Path Parameter — Base site identifier
catalogId (required)
Path Parameter — The catalog uid
pageId (required)
Path Parameter — The uid of the page from which to retrieve the synchronization status
targetCatalogVersion (required)
Path Parameter — The target catalog version from a synchronization perspective
versionId (required)
Path Parameter — The source catalog version from a synchronization perspective

Return type

syncItemStatus

Example data

Content-Type: application/json
{
  "catalogVersionUuid" : "catalogVersionUuid",
  "dependentItemTypesOutOfSync" : [ {
    "itemType" : "itemType",
    "i18nKey" : "i18nKey"
  }, {
    "itemType" : "itemType",
    "i18nKey" : "i18nKey"
  } ],
  "itemId" : "itemId",
  "itemType" : "itemType",
  "lastModifiedDate" : 0,
  "selectedDependencies" : [ null, null ],
  "name" : "name",
  "sharedDependencies" : [ null, null ],
  "lastSyncStatus" : 6,
  "status" : "status",
  "unavailableDependencies" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

item containing the complex synchronization status of the AbstractPageModel page syncItemStatus

401

Must be authenticated as an Admin or CMS Manager to access this resource
Up 
post /v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}
Perform synchronization (performSync)
Will perform synchronization status on a list of item identifier by their ItemSynchronizationData.

Path parameters

baseSiteId (required)
Path Parameter — Base site identifier
catalogId (required)
Path Parameter — The catalog uid
targetCatalogVersion (required)
Path Parameter — The target catalog version from a synchronization perspective
versionId (required)
Path Parameter — The source catalog version from a synchronization perspective

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

synchronizationData SynchronizationData (required)
Body Parameter — The SynchronizationData containing the list of requested synchronizations

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

Workflows

Up 
get /v1/catalogs/{catalogId}/versions/{versionId}/workfloweditableitems
Retrieves the list of objects that tells whether a particular item is editable in any workflow or not (getEditableWorkflowItems)
Retrieves the list of objects that tells whether a particular item is editable in any workflow or not

Path parameters

catalogId (required)
Path Parameter — The uid of the catalog
versionId (required)
Path Parameter — The uid of the catalog version

Query parameters

itemUids (required)
Query Parameter — List of item uids

Return type

CMSWorkflowEditableItemListData

Example data

Content-Type: application/json
{
  "editableItems" : [ {
    "uid" : "uid",
    "uuid" : "uuid",
    "editableByUser" : true,
    "editableInWorkflow" : "editableInWorkflow"
  }, {
    "uid" : "uid",
    "uuid" : "uuid",
    "editableByUser" : true,
    "editableInWorkflow" : "editableInWorkflow"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The item containing the list of objects that tells whether a particular item is editable in any workflow or not. CMSWorkflowEditableItemListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

404

When no cms item is found matching the given uid (UnknownIdentifierException).

Models

[ Jump to Methods ]

Table of Contents

  1. AbstractPageData - AbstractPageData
  2. CMSComponentTypeListData - CMSComponentTypeListData
  3. CMSPageOperationData - CMSPageOperationData
  4. CMSWorkflowActionData - CMSWorkflowActionData
  5. CMSWorkflowAttachmentData - CMSWorkflowAttachmentData
  6. CMSWorkflowEditableItemData - CMSWorkflowEditableItemData
  7. CMSWorkflowEditableItemListData - CMSWorkflowEditableItemListData
  8. CMSWorkflowTaskData - CMSWorkflowTaskData
  9. CMSWorkflowTaskListData - CMSWorkflowTaskListData
  10. CatalogListData - CatalogListData
  11. CategoryData - CategoryData
  12. CategorySearchResultData - CategorySearchResultData
  13. ComponentTypeAttributeData - ComponentTypeAttributeData
  14. ComponentTypeData - ComponentTypeData
  15. DisplayConditionData - DisplayConditionData
  16. MediaData - MediaData
  17. OptionData - OptionData
  18. ProductData - ProductData
  19. ProductSearchResultData - ProductSearchResultData
  20. SynchronizationData - SynchronizationData
  21. catalog - catalog
  22. catalogVersion - catalogVersion
  23. homepage - homepage
  24. itemSynchronization - itemSynchronization
  25. itemType - itemType
  26. pagination - pagination
  27. syncItemStatus - syncItemStatus

AbstractPageData - AbstractPageData Up

catalogVersionUuid (optional)
String
cloneComponents (optional)
Boolean
creationtime (optional)
Date format: date-time
defaultPage (optional)
Boolean
modifiedtime (optional)
Date format: date-time
name (optional)
String
onlyOneRestrictionMustApply (optional)
Boolean
pk (optional)
String
restrictions (optional)
array[String]
template (optional)
String
title (optional)
map[String, String]
typeCode (optional)
String
uid (optional)
String

CMSComponentTypeListData - CMSComponentTypeListData Up

componentTypes (optional)
array[ComponentTypeData]
pagination (optional)
pagination

CMSPageOperationData - CMSPageOperationData Up

catalogId (optional)
String
operation (optional)
String
sourceCatalogVersion (optional)
String
targetCatalogVersion (optional)
String

CMSWorkflowActionData - CMSWorkflowActionData Up

code (optional)
String
description (optional)
String
isCurrentUserParticipant (optional)
Boolean
modifiedtime (optional)
Date format: date-time
name (optional)
String
startedAgoInMillis (optional)
Long format: int64
status (optional)
String

CMSWorkflowAttachmentData - CMSWorkflowAttachmentData Up

catalogId (optional)
String
catalogName (optional)
String
catalogVersion (optional)
String
pageName (optional)
String
pageUid (optional)
String

CMSWorkflowEditableItemData - CMSWorkflowEditableItemData Up

Contains information about whether the item from a workflow is editable by session user or not.
editableByUser (optional)
Boolean Indicates whether the session user can edit the item from a workflow or not.
editableInWorkflow (optional)
String Contains the workflow code where item can be edited. It either contains the code of the oldest workflow that contains item or null if there is no workflow. Is used by SmartEdit ui to restrict user from editing an item in a workflow that is not the oldest one.
uid (optional)
String
uuid (optional)
String

CMSWorkflowEditableItemListData - CMSWorkflowEditableItemListData Up

editableItems (optional)
array[CMSWorkflowEditableItemData]

CMSWorkflowTaskData - CMSWorkflowTaskData Up

action (optional)
CMSWorkflowActionData
attachments (optional)
array[CMSWorkflowAttachmentData]

CMSWorkflowTaskListData - CMSWorkflowTaskListData Up

pagination (optional)
pagination
tasks (optional)
array[CMSWorkflowTaskData]

CatalogListData - CatalogListData Up

List of catalogs
catalogs (optional)
array[catalog]

CategoryData - CategoryData Up

catalogId (optional)
String
catalogVersion (optional)
String
code (optional)
String
description (optional)
map[String, String]
name (optional)
map[String, String]
thumbnail (optional)
MediaData
uid (optional)
String

CategorySearchResultData - CategorySearchResultData Up

item which serves as a wrapper object that contains a list of CategoryData
pagination (optional)
pagination
productCategories (optional)
array[CategoryData]

ComponentTypeAttributeData - ComponentTypeAttributeData Up

cmsStructureEnumType (optional)
String
cmsStructureType (optional)
String
collection (optional)
Boolean
containedTypes (optional)
array[String]
dependsOn (optional)
String
editable (optional)
Boolean
i18nKey (optional)
String
idAttribute (optional)
String
labelAttributes (optional)
array[String]
localized (optional)
Boolean
options (optional)
array[OptionData]
paged (optional)
Boolean
params (optional)
map[String, String]
placeholder (optional)
String
qualifier (optional)
String
required (optional)
Boolean
subTypes (optional)
map[String, String]
uri (optional)
String

ComponentTypeData - ComponentTypeData Up

attributes (optional)
array[ComponentTypeAttributeData]
category (optional)
String
code (optional)
String
i18nKey (optional)
String
name (optional)
String
type (optional)
String

DisplayConditionData - DisplayConditionData Up

options (optional)
array[OptionData]
typecode (optional)
String

MediaData - MediaData Up

altText (optional)
String
catalogId (optional)
String
catalogVersion (optional)
String
code (optional)
String
description (optional)
String
downloadUrl (optional)
String
mime (optional)
String
url (optional)
String

OptionData - OptionData Up

id (optional)
String
label (optional)
String

ProductData - ProductData Up

catalogId (optional)
String
catalogVersion (optional)
String
code (optional)
String
description (optional)
map[String, String]
name (optional)
map[String, String]
thumbnail (optional)
MediaData
uid (optional)
String

ProductSearchResultData - ProductSearchResultData Up

pagination (optional)
pagination
products (optional)
array[ProductData]

SynchronizationData - SynchronizationData Up

items (optional)
array[itemSynchronization]

catalog - catalog Up

Catalog item
catalogId (optional)
String
name (optional)
map[String, String]
versions (optional)
array[catalogVersion]

catalogVersion - catalogVersion Up

active (optional)
Boolean
homepage (optional)
homepage
pageDisplayConditions (optional)
array[DisplayConditionData]
thumbnailUrl (optional)
String
uuid (optional)
String
version (optional)
String

homepage - homepage Up

current (optional)
AbstractPageData
fallback (optional)
AbstractPageData
old (optional)
AbstractPageData

itemSynchronization - itemSynchronization Up

itemId (optional)
String
itemType (optional)
String

itemType - itemType Up

i18nKey (optional)
String
itemType (optional)
String

pagination - pagination Up

Pagination info
count (optional)
Integer Number of elements on this page format: int32
hasNext (optional)
Boolean Indicates if there is next page
hasPrevious (optional)
Boolean Indicates if there is previous page
page (optional)
Integer Current page number format: int32
totalCount (optional)
Long Total number of elements format: int64
totalPages (optional)
Integer Total number of pages format: int32

syncItemStatus - syncItemStatus Up

item that contains the complex synchronization status of the page
catalogVersionUuid (optional)
String
dependentItemTypesOutOfSync (optional)
array[itemType]
itemId (optional)
String
itemType (optional)
String
lastModifiedDate (optional)
Long format: int64
lastSyncStatus (optional)
Long format: int64
name (optional)
String
selectedDependencies (optional)
array[syncItemStatus]
sharedDependencies (optional)
array[syncItemStatus]
status (optional)
String
unavailableDependencies (optional)
array[syncItemStatus]