Jump to

• Request
• Response

Update a REST module template

put

/ords/rest/templates/{id}

Updates a REST module template.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• comments: string
  Comment text.
• etag_query: string
  Query that is used to generate the entity tag.
• etag_type(required): 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.
• priority(required): integer
  The priority for the order of how the resource template should be evaluated: 0 (low priority. the default) through 9 (high priority).
• uri_prefix(required): 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.)

{
    "type":"object",
    "required":[
        "uri_prefix",
        "priority",
        "etag_type"
    ],
    "properties":{
        "uri_prefix":{
            "type":"string",
            "description":"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.)"
        },
        "priority":{
            "type":"integer",
            "description":"The priority for the order of how the resource template should be evaluated: 0 (low priority. the default) through 9 (high priority)."
        },
        "etag_type":{
            "type":"string",
            "description":"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."
        },
        "etag_query":{
            "type":"string",
            "description":"Query that is used to generate the entity tag."
        },
        "comments":{
            "type":"string",
            "description":"Comment text."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of the REST module template 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"
    ]
}

400 Response

No etag_type or pattern or priority parameter provided.

404 Response

Template does not exist

409 Response

Template pattern already exists in the module.

Back to Top