Published REST Resource

Last update: Download PDF Edit

1 Introduction

A published REST resource is part of a published REST service and represents a collection of items on which one or more operations can be defined.

You can generate a published REST resource from an entity in your domain model. See Generate a Published REST resource.

2 General

2.1 Resource Name

The resource name uniquely identifies the resource in the service. It is part of the location of the operations, so it cannot contain spaces or special characters.

2.2 Public Documentation

The public documentation is used in the service’s OpenAPI (Swagger) documentation page. You can use GitHub-flavored markdown for rich text.