Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
Top

...

GET (Using Query Parameters)

This GET service will return a list of resource types in the form of JSON objects based on a query parameter for the display name. Resource Types are only returned if they contain the specified parameter. If no query parameters are given this request will return the entire list of resource types.

Info
titleAPI URLs

http://host:port/flexdeploy/rest/administration/resourcetypes?

Append the following character sequences to the above URL to specify Query parameters.

resourceTypeName={resourceTypeName}

Examples:
To return all of the resource types:

http://host:port/flexdeploy/rest/administration/resourcetypes

To search by name only:

http://host:port/flexdeploy/rest/administration/resourcetypes?resourceTypeName={resourceTypeName}

...

Parameter

Type

Required

Description

resourceTypeNameURLNoThis is a URL query parameter for the name which is used to search the resource types.

Example

If we had a there are resource types in our the database with the following attributes:

Code Block
themeEclipse
titleResource Type
[
{
    "resourceTypeName": "Oracle Forms and Reports Server",
    "resourceTypeId": 24400,
    "isActive": true,
    "description": null
},
{
    "resourceTypeName": "EBS Forms Service",
    "resourceTypeId": 19182,
    "isActive": true,
    "description": null
}
]

...

The GET request would return theĀ  the following JSON resource type object

...

The PUT request would then update the resource type with Id 10000 and return theĀ  the following JSON resource type object

...

Back to Top

...

PATCH

This PATCH service will update an existing resource type with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the resource type.

Info
titleAPI URL

http://host:port/flexdeploy/administration/resourcetypes/{Id}

...