Available from 5.6.0.1

Resource Types can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of Resource Types.

Authentication - Use Basic Authentication for this API.

GET

There are two implementations of GET. One will find a Resource Type with the given Id and return the JSON representation of the Resource Type. The other will find a list of Resource Types matching the parameters supplied to it.

GET by ID

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

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "resourceTypeName": "Get Example Name",
    "isActive": true,
    "createdOn": 1629882360332,
    "versionNumber": 1,
    "createdBy": "fdadmin",
    "resourceTypeId": 20408,
    "updatedBy": "fdadmin",
    "updatedOn": 1629882360332
}

This GET service will return a list of Resource Types in the form of JSON objects based on the query parameters resourceTypeId, resourceTypeName, ownerType, and isActive. Resource Types are only returned if they match ALL of the specified query parameters. If no query parameters are given this request will return the entire list of Resource Types. The resourceTypeName parameter returns Resource Types that contain the specified parameter. The other parameters must be equal to the Resource Types.

Request

Response Codes

Example

Output when querying by isActive through http://host:port/flexdeploy/rest/v2/administration/resourcetype?isActive=false

[
    {
        "description": "Postman test data 1 updated",
        "ownerType": null,
        "resourceTypeName": "Get Example Name updated1",
        "isActive": false,
        "createdOn": 1629882360332,
        "versionNumber": 1,
        "createdBy": "fdadmin",
        "resourceTypeId": 20408,
        "updatedBy": "fdadmin",
        "updatedOn": 1629883055449
    }
]

POST

The POST service will create a new Resource Type with the same attributes as the given JSON object. It returns the JSON representation of the Resource type that was just created with an updated ID attribute.

Request

Response Codes

Example

If the POST receives the following JSON Resource Type object,

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "isActive": true,
    "resourceTypeName": "Get Example Name"
}

the following Resource Type will be created in the database. Notice the updated Resource Type Id field.

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "resourceTypeName": "Get Example Name",
    "isActive": true,
    "createdOn": 1629882360332,
    "versionNumber": 1,
    "createdBy": "fdadmin",
    "resourceTypeId": 20408,
    "updatedBy": "fdadmin",
    "updatedOn": 1629882360332
}

PUT

This PUT service will update all attributes of a Resource Types with the given Id based on the attributes of the supplied JSON object.

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "resourceTypeName": "Get Example Name",
    "isActive": true,
    "createdOn": 1629882360332,
    "versionNumber": 1,
    "createdBy": "fdadmin",
    "resourceTypeId": 20408,
    "updatedBy": "fdadmin",
    "updatedOn": 1629882360332
}

{
    "description": "Postman test data 1 updated",
	"ownerType": "",
	"isActive":false,
	"resourceTypeName": "Get Example Name updated"
}

{
    "description": "Postman test data 1 updated",
    "ownerType": "",
    "resourceTypeName": "Get Example Name updated",
    "isActive": false,
    "createdOn": 1629882360332,
    "versionNumber": 2,
    "createdBy": "fdadmin",
    "resourceTypeId": 20408,
    "updatedBy": "fdadmin",
    "updatedOn": 1629882746226
}

This PATCH service will update the information of the Resource Type of the specified Id with the non-null parameters of the JSON. The parameters that are null or missing will not be changed in the Resource Type.

Request

Response Codes

Example

If we had a Resource Type in our database with an Id of 20408 and had the following attributes

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "resourceTypeName": "Get Example Name 1",
    "isActive": true,
    "createdOn": 1629882360332,
    "versionNumber": 1,
    "createdBy": "fdadmin",
    "resourceTypeId": 20408,
    "updatedBy": "fdadmin",
    "updatedOn": 1629882360332
}

When we run a PATCH request at the following URL

http://host:port/flexdeploy/rest/v2/administration/resourcetype/20408

And the PATCH request receives the following JSON Resource Types object,

{
    "resourceTypeName": "Get Example Name patched"
}

The PATCH request would then update the Resource Type with Id 20408 and return the following JSON Resource Type object.

{
    "description": "Postman test data 1",
    "ownerType": "Workflow",
    "resourceTypeName": "Get Example Name patched",
    "isActive": true,
    "createdOn": 1629882360332,
    "versionNumber": 2,
    "createdBy": "fdadmin",
    "resourceTypeId": 20408,
    "updatedBy": "fdadmin",
    "updatedOn": 1629882779169
}

This DELETE service will find the Resource Type with the given Id and deletes it. 

Request

Response Codes