Resource Types API

Resource Types can be accessed through this API using GET, POST, PUT and PATCH. This service retrieves information about resource types.

GET

GET by ID

This GET service will find a resource type with the given Id and return the JSON representation of the object. 

API URL

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

Request

Parameter

Type

Required

Description

Id

URLYesThis is a URL parameter for the Id which is used to find and return a resource type

Response

AttributesTypeDescription
descriptionStringThe description of the resource type.
resourceTypeIdLongThe unique Id of the resource type.
resourceTypeNameStringThe unique name of the resource type.
isActiveBooleanThe boolean representing whether the resource type is active. If isActive is updated to null it will default to true.

Response Codes

HTTP Code
Description
200Resource type found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Resource type not found
500Unexpected internal server error

Example

If we had a resource type in our database with an Id of 10000 and had the following attributes

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server",
    "resourceTypeId": 10000,
    "isActive": true,
    "description": null
}

When we run a GET request at the following URL

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

The GET request would return the following JSON rseource type object

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server",
    "resourceTypeId": 10000,
    "isActive": true,
    "description": null
}

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.

API URLs

http://host:port/flexdeploy/rest/v1/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/v1/administration/resourcetypes

To search by name only:

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

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

Request

Parameter

Type

Required

Description

resourceTypeNameQuery - StringNo

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

Contains ignore case type search.

Response

AttributesTypeDescription
descriptionStringThe description of the resource type.
resourceTypeIdLongThe unique Id of the resource type.
resourceTypeNameStringThe unique name of the resource type.
isActiveBooleanThe boolean representing whether the resource type is active. If isActive is updated to null it will default to true.

Response Codes

HTTP Code
Description
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If there are resource types in the database with the following attributes:

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

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/administration/resourcetypes?resourceTypeName=forms

The GET request would return the following JSON resource type object

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

POST

This POST service will create a new resource type with the same attributes as the given JSON object.

API URL

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

Request

AttributesTypeRequiredDescription
descriptionStringNoThe description of the resource type.
resourceTypeIdLongNoThe unique Id of the resource type.
resourceTypeNameStringYesThe unique name of the resource type.
isActiveBooleanNoThe boolean representing whether the resource type is active. If isActive is set to null it will default to true.

Response

AttributesTypeDescription
descriptionStringThe description of the resource type.
resourceTypeIdLongThe unique Id of the resource type.
resourceTypeNameStringThe unique name of the resource type.
isActiveBooleanThe boolean representing whether the resource type is active. If isActive is updated to null it will default to true.

Response Codes

HTTP Code
Description
201Resource type created
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If the POST request receives the following JSON resource type object,

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server",
    "resourceTypeId": 10000,
    "isActive": true,
    "description": null
}

The following resource type object will then be created as a new row in the database.

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server",
    "resourceTypeId": 24400,
    "isActive": true,
    "description": null
}

PUT

This PUT service will update all attributes of a resource type with the given Id based on the attributes of a JSON object parameters.

Request

AttributesTypeRequiredDescription
descriptionStringNoThe description of the resource type.
resourceTypedLongNoThe unique Id of the resource type.
resourceTypeNameStringYesThe unique name of the resource type.
isActiveBooleanNoThe boolean representing whether the resource type is active. If isActive is updated to null it will default to true.

Response

AttributesTypeDescription
descriptionStringThe description of the resource type.
resourceTypeIdLongThe unique Id of the resource type.
resourceTypeNameStringThe unique name of the resource type.
isActiveBooleanThe boolean representing whether the resource type is active. If isActive is updated to null it will default to true.

Response Codes

HTTP Code
Description
200Resource type found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Resource type not found
500Unexpected internal server error

Example

If we had a resource type in our database with an Id of 10000 and had the following attributes

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server",
    "resourceTypeId": 10000,
    "isActive": true,
    "description": null
}

When we run a PUT request at the following URL

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

And the PUT request receives the following JSON resource type object,

Resource Type PUT Receive JSON
{
    "resourceTypeName": "Oracle Forms and Reports Server Updated",
    "resourceTypeId": 10001,
    "isActive": false,
    "description": "Updated Resource type"
}

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

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server Updated",
    "resourceTypeId": 10000,
    "isActive": false,
    "description": "Updated Resource type"
}

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.

API URL

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

Request

AttributesTypeRequiredDescription
descriptionStringNoThe description of the resource type.
resourceTypeIdLongNoThe unique Id of the resource type.
resourceTypeNameStringNoThe unique name of the resource type.
isActiveBooleanNoThe boolean representing whether the resource type is active.

Response

AttributesTypeDescription
descriptionStringThe description of the resource type.
resourceTypeIdLongThe unique Id of the resource type.
resourceTypeNameStringThe unique name of the resource type.
isActiveBooleanThe boolean representing whether the resource type is active. If isActive is updated to null it will default to true.

Response Codes

HTTP Code
Description
200Resource type found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Resource type not found
500Unexpected internal server error

Example

If we had a resource type in our database with an Id of 10000 and had the following attributes

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server",
    "resourceTypeId": 10000,
    "isActive": true,
    "description": null
}

When we run a PATCH request at the following URL

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

And the PATCH request receives the following JSON resource type object,

Resource Type - 10000
{
	"resourceTypeName": "Oracle Forms and Reports Server Patched"
}

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

Resource Type - 10000
{
    "resourceTypeName": "Oracle Forms and Reports Server Patched",
    "resourceTypeId": 10000,
    "isActive": true,
    "description": null
}