Available from 5.6.0.1

Request

Parameter	Required	Type	Description
Id	Yes	URL	URL parameter for the Id which is used to find and return a Resource Type

Response Codes

HTTP Code	Description
200	Resource Type was 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 a Resource Type in our database with an Id of 20405 and the following attributes

When we run a GET request at the following URL

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

The GET request would return the following JSON Resource Type object

Code Block

theme	Eclipse
title	Resource type GET Return JSON

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "isActive": true,
    "resourceTypeName": "Postman Resource Type Test REST 1",
    "versionNumberisActive": 1true,
    "resourceTypeIdcreatedOn": 20405
}

GET by Query Parameters

...

1629882360332,
    "versionNumber": 1,
    "createdBy": "fdadmin",
    "resourceTypeId": 20405,
    "updatedBy": "fdadmin",
    "updatedOn": 1629882360332
}

GET by Query Parameters

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.

Info

title	API URL

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

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

resourceTypeId={resourceTypeId}

resourceTypeName={resourceTypeName}

isActive={isActive}

ownerType={ownerType}

Examples:

To Specify the code parameter only:

http://host:port/flexdeploy/rest/v2/administration/resourcetype?resourceTypeId={resourceTypeId}

To Specify the code and group code parameters:

http://host:port/flexdeploy/rest/v2/resourcetype?resourceTypeId={resourceTypeId}&resourceTypeName={resourceTypeName}

To Specify the name, group code, and sub group code parameters:

http://host:port/flexdeploy/rest/v2/resourcetype?resourceTypeId={resourceTypeId}&resourceTypeName={resourceTypeName}&ownerType={ownerType}

Tip
The query parameters are not case sensitive. Searching by resourceTypeName=NAME is the same as searching by resourceTypeName=name.

...

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

Code Block

title	Sample JSON Output
collapse	true

[
    {
        "description": "Postman test data Updated1 descriptionupdated",
        "ownerType": null,
        "isActive": false,
        "resourceTypeName": "Postman Resource Type Test REST 1 patchedupdated1",
        "versionNumberisActive": 3false,
        "createdBycreatedOn": "fdadmin"1629882360332,
        "versionNumber": 1,
        "createdBy": "fdadmin",
        "resourceTypeId": 20408,
  20401      }
]

POST

...

"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.

...

Attributes	Type	Required	Description
resourceTypeName	String	Yes	Name of Resource Type
isActive	Boolean	No	Whether or not this Resource Type is active.
description	String	No	Description of the Resource Type.
ownerType	String	No	Owner Type value of the Resource Type.

Response Codes

...

HTTP Code

...

Description

...

Example

...

of the Resource Type.

Response Codes

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

Example

If the POST receives the following JSON Resource Type object,

Code Block

title	Sample JSON Input
collapse	true

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "isActive": true,
    "resourceTypeName": "Postman Resource Type Test REST 1",
}

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

Code Block

title	Sample JSON InputOutput
collapse	true

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "isActive": true,
    "resourceTypeName": "Postman Resource Type Test REST 1",
}

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

Code Block

title	Sample JSON Output
collapse	true

{
	"description": "Postman test data1",
	"ownerType": "Workflow",
	"isActive": true,
	"resourceTypeName": "Postman Resource Type Test REST 1",
	"versionNumber": 1,
	"resourceTypeId": 20408
    "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.

Info

title	API URL

http://host:port/flexdeploy/rest/v2/administration/resourcetype/{Id}

Request

Attributes	Type	Required	Description
Id	URL	Yes	URL parameter for the Id which is used to find and update a Resource Type.
resourceTypeName	String	Yes	Name of Resource Type.
isActive	Boolean	No	Whether or not this Resource Type is active. Defaults to true if nothing is passed.
ownerType	String	No	Owner Type value of the Resource Type.

Response Codes

HTTP Code	Description
200	Resource Type was 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 an Resource Type in our database with an Id of 20408 and had the following attributes

{

Code Block

title	Current Resource Type
collapse	true


collapse	true

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "descriptionresourceTypeName": "Postman test data1Resource Type Test REST 1",
    "ownerTypeisActive": "Workflow"true,
    "createdOn": 1629882360332,
    "isActiveversionNumber": true1,
    "resourceTypeNamecreatedBy": "fdadmin"Postman,
Resource Type Test REST 1"resourceTypeId": 20405,
    "versionNumberupdatedBy": 1"fdadmin",
    "resourceTypeIdupdatedOn": 204081629882360332
}

When we run a PUT request at the following URL

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

And the PUT request receives the following JSON Resource Type object,

Code Block

title	Sample JSON Input
collapse	true

{
    "description": "Postman test data 1 updated",
	"ownerType": "",
	"isActive":false,
	"resourceTypeName": "Postman Resource Type Test REST 1 updated"
}

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

{ "description

Code Block

title	Sample JSON Output
collapse	true

true

{
    "description": "Postman test data 1 updated",
    "ownerType": "",
    "resourceTypeName": "Postman Resource testType Test dataREST 1 updated",
    "ownerTypeisActive": false,
    "createdOn": 1629882360332,
    "isActiveversionNumber": true2,
    "resourceTypeNamecreatedBy": "fdadmin"Postman,
Resource Type Test REST 1 updated"resourceTypeId": 20408,
    "versionNumberupdatedBy": 2"fdadmin",
    "resourceTypeIdupdatedOn": 204081629882746226
}

PATCH

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.

...

Code Block

title	Current Resource Type
collapse	true

{
    "description": "Postman test data1",
    "ownerType": "Workflow",
    "resourceTypeName": "Postman Resource Type Test REST 1",
    "isActive": true,
    "resourceTypeNamecreatedOn": 1629882360332,
    "versionNumber": 1,
    "createdBy": "fdadmin"Postman,
Resource Type Test REST 1"resourceTypeId": 20405,
    "versionNumberupdatedBy": 1"fdadmin",
    "resourceTypeIdupdatedOn": 204081629882360332
}

When we run a PATCH request at the following URL

...

Code Block

title	Sample JSON Output
collapse	true

{
    "description"description": "Postman test data 1",
    "ownerType": "Workflow",
    "resourceTypeName": "Postman Resource Type testTest dataREST 1 updatedpatched",
    "ownerTypeisActive": "Workflow"true,
    "createdOn": 1629882360332,
    "isActiveversionNumber": true2,
    "resourceTypeNamecreatedBy": "fdadmin"Postman,
Resource Type Test REST 1 patched""resourceTypeId": 20408,
    "versionNumberupdatedBy": 2"fdadmin",
    "resourceTypeIdupdatedOn": 204081629882779169
}

DELETE

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

...

Versions Compared

Old Version 3

New Version 4

Key

Request

Response Codes

Example

GET by Query Parameters

GET by Query Parameters

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To Specify the code parameter only:

To Specify the code and group code parameters:

To Specify the name, group code, and sub group code parameters:

POST

POST

Response Codes

Example

Response Codes

Example

PUT

Request

Response Codes

Example

PATCH

DELETE

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Request

Response Codes

Example

GET by Query Parameters

GET by Query Parameters

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To Specify the code parameter only:

To Specify the code and group code parameters:

To Specify the name, group code, and sub group code parameters:

POST

POST

Response Codes

Example

Response Codes

Example

PUT

Request

Response Codes

Example

PATCH

DELETE