Resource Types can be accessed through this API using GET, POST, PUT and PATCH. This service retrieves information about resource types.
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/administration/resourcetypes/{Id} |
Request
Parameter | Type | Required | Description |
|---|---|---|---|
Id | URL | Yes | This is a URL parameter for the Id which is used to find and return a resource type |
Response
| Attributes | Type | Description |
|---|---|---|
| description | String | The description of the resource type. |
| resourceTypeId | Long | The unique Id of the resource type. |
| resourceTypeName | String | The unique name of the resource type. |
| isActive | Boolean | The boolean representing whether the resource type is active. If isActive is updated to null it will default to true. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Resource type found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Resource type not found |
| 500 | Unexpected internal server error |
Example
If we had a resource type in our database with an Id of 10000 and had the following attributes
...
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 | ||
|---|---|---|
| ||
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} |
...
| Tip |
|---|
The query parameters are not case sensitive. Searching by name=EXAMPLE is the same as searching by name=example. |
Request
Parameter | Type | Required | Description |
|---|---|---|---|
| resourceTypeName |
| Query - String | No | This is a URL query parameter for the name which is used to search the resource types. Contains ignore case type search. |
Response
| Attributes | Type | Description |
|---|---|---|
| description | String | The description of the resource type. |
| resourceTypeId | Long | The unique Id of the resource type. |
| resourceTypeName | String | The unique name of the resource type. |
| isActive | Boolean | The boolean representing whether the resource type is active. If isActive is updated to null it will default to true. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Search successful and results returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
If there are resource types in the database with the following attributes:
...
| Attributes | Type | Description |
|---|---|---|
| description | String | The description of the resource type. |
| resourceTypeId | Long | The unique Id of the resource type. |
| resourceTypeName | String | The unique name of the resource type. |
| isActive | Boolean | The boolean representing whether the resource type is active. If isActive is updated to null it will default to true. |
Response Codes
HTTP Code | Description |
|---|---|
| 201 | Resource type created |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
If the POST request receives the following JSON resource type object,
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/administration/resourcetypes/{Id} |
...
| Attributes | Type | Description |
|---|---|---|
| description | String | The description of the resource type. |
| resourceTypeId | Long | The unique Id of the resource type. |
| resourceTypeName | String | The unique name of the resource type. |
| isActive | Boolean | The boolean representing whether the resource type is active. If isActive is updated to null it will default to true. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Resource type found and updated |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Resource type not found |
| 500 | Unexpected internal server error |
Example
If we had a resource type in our database with an Id of 10000 and had the following attributes
...
http://host:port/flexdeploy/rest/v1/administration/resourcetypes/10000
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/administration/resourcetypes/{Id} |
...
| Attributes | Type | Description |
|---|---|---|
| description | String | The description of the resource type. |
| resourceTypeId | Long | The unique Id of the resource type. |
| resourceTypeName | String | The unique name of the resource type. |
| isActive | Boolean | The boolean representing whether the resource type is active. If isActive is updated to null it will default to true. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Resource type found and updated |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Resource type not found |
| 500 | Unexpected internal server error |
Example
If we had a resource type in our database with an Id of 10000 and had the following attributes
...
http://host:port/flexdeploy/rest/v1/administration/resourcetypes/10000
...