Jump to

• Request
• Response

Update a REST module

put

/ords/rest/modules/{id}

Updates a REST module.

Request

Path Parameters

• id(required): integer
  ID for specific module.

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(required): 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.

{
    "type":"object",
    "required":[
        "name",
        "base_path",
        "module_status"
    ],
    "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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of the REST module that has been successfully updated.

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"
    ]
}

400 Response

No items_per_page or status parameter provided.

404 Response

No name or base_path parameter provided.

409 Response

A module name or base path already exists.

Back to Top