| Anchor | ||||
|---|---|---|---|---|
|
...
This GET service will find a resource type with the given Id and return the JSON representation of the object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/administration/resourcetypes/{Id} |
Parameters
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 |
...
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/administration/resourcetypesresourcetypes/10000
The GET request would return the following JSON rseource type object
...
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/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} |
...
This POST service will create a new resource type with the same attributes as the given JSON object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/administration/resourcetypes |
Parameters
| Attributes | Type | Required | Description |
|---|---|---|---|
| description | String | No | The description of the resource type. |
| resourceTypeId | Long | No | The unique Id of the resource type. |
| resourceTypeName | String | Yes | The unique name of the resource type. |
| isActive | Boolean | No | The boolean representing whether the resource type is active. If isActive is set to null it will default to true. |
...
...
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/administration/resourcetypes/{Id} |
Parameters
| Attributes | Type | Required | Description |
|---|---|---|---|
| description | String | No | The description of the resource type. |
| resourceTypeId | Long | No | The unique Id of the resource type. |
| resourceTypeName | String | No | The unique name of the resource type. |
| isActive | Boolean | No | The boolean representing whether the resource type is active. |
...