Versions Compared

Key

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

Anchor
Top
Top

Resource Types can be accessed through this API using GET. This service retrieves information about resource types.

...

Table of Contents
maxLevel1

Back to Top

...

GET

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}

...

Tip

The query parameters are not case sensitive. Searching by name=EXAMPLE is the same as searching by name=example.

Parameters


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 resource types in our 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
}
]

Back to Top

...