Versions Compared

Key

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

Anchor
Top
Top

...

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

...

Code Block
themeEclipse
titleResource Type - 10000
{
    "descriptionresourceTypeName": "test",Oracle Forms and Reports Server"isFDAdmin":,
false,    "groupIdresourceTypeId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",

     "actionTypedescription": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ]}
}null
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/administration/securityresourcetypes/group/10000

The GET request would return the following JSON group rseource type object

Code Block
themeEclipse
titleGroup Resource Type - 10000
{
    "descriptionresourceTypeName": "test",Oracle Forms and Reports Server"isFDAdmin":,
false,    "groupIdresourceTypeId": 10000,
   "groupName": "test",    "isActive": true,
   "globalPermissions": [
  {       "objectTypedescription": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ]}
}null
}

Back to 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}

...

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

...

POST

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

Info
titleAPI URL

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

Parameters

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.

Example

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

Code Block
themeEclipse
titleResource 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.

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


Back to Top

...

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.

Info
titleAPI URL

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

Parameters

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.

Example

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

Code Block
themeEclipse
titleResource 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/administration/resourcetypes/10000

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

Code Block
themeEclipse
titleResource 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

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


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}

Parameters

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.

Example

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

Code Block
themeEclipse
titleResource 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/administration/resourcetypes/10000

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

Code Block
themeEclipse
titleResource 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

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

Back to Top

...


...