Create a REST module template
post
/ords/_/db-api/stable/ords/rest/templates/
Creates a REST module template.
Request
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
comments(optional):
string
Comment text.
-
etag_query(optional):
string
Query that is used to generate the entity tag.
-
etag_type(optional):
string
A type of entity tag to be used by the resource template. An entity tag is an HTTP Header that acts as a version identifier for a resource. Use entity tag headers to avoid retrieving previously retrieved resources and to perform optimistic locking when updating resources. Valid values are HASH, QUERY, NONE.
-
module_id:
integer
ID for specific reosurce module
-
priority(optional):
integer
The priority for the order of how the resource template should be evaluated: 0 (low priority. the default) through 9 (high priority).
-
run_mode(optional):
string
Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution.
-
uri_prefix:
string
A matching pattern for the resource template. For example, a pattern of /objects/:object/:id? will match /objects/emp/101 (matches a request for the item in the emp resource with id of 101) and will also match /objects/emp/. (Matches a request for the emp resource, because the :id parameter is annotated with the ? modifier, which indicates that the id parameter is optional.)
Response
Supported Media Types
- application/json
201 Response
Details of the REST module template that has been successfully created.
400 Response
No pattern parameter provided or Module not specified.
404 Response
Module does not exist
409 Response
A template with that pattern already exists.