Jump to

• Request
• Response

Create a REST module

post

/ords/rest/modules/

Creates a REST module.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• base_path(required): string
  The base of the URI that is used to access this RESTful service. Example: hr/ means that all URIs starting with hr/ will be serviced by this resource module.
• comments: string
  Comment text.
• items_per_page: integer
  The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: 25.
• module_status: string
  Publication status. Valid values: PUBLISHED (default) or NOT_PUBLISHED.
• name(required): string
  Name of the owning RESTful service module. Case sensitive.
• origins_allowed: string
  Set the allowed origins for the module containing the web service call.
• run_mode: 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.

{
    "type":"object",
    "required":[
        "name",
        "base_path"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the owning RESTful service module. Case sensitive."
        },
        "base_path":{
            "type":"string",
            "description":"The base of the URI that is used to access this RESTful service. Example: hr/ means that all URIs starting with hr/ will be serviced by this resource module."
        },
        "origins_allowed":{
            "type":"string",
            "description":"Set the allowed origins for the module containing the web service call."
        },
        "items_per_page":{
            "type":"integer",
            "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: 25."
        },
        "module_status":{
            "type":"string",
            "description":"Publication status. Valid values: PUBLISHED (default) or NOT_PUBLISHED."
        },
        "comments":{
            "type":"string",
            "description":"Comment text."
        },
        "run_mode":{
            "type":"string",
            "description":"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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Source code of the REST module to be created. Used for showcode.

Body ()

Root Schema : ResourceItem

Type: object

Additional Properties Allowed: true

Show Source

• links: array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

201 Response

Details of the REST module that has been successfully created.

Body ()

Root Schema : ResourceItem

Type: object

Additional Properties Allowed: true

Show Source

• links: array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

404 Response

No name or base_path parameter provided.

409 Response

A module with that name or base path already exists.

Back to Top