Property Set API v2
Property Sets can be accessed through this API using service: GET. This service allow for the retrieval of Property Sets.
Authentication - Use Basic Authentication for this API.
- 1 GET
- 1.1 GET by ID
- 1.2 GET by Query Parameters
GET
There are two implementations of GET. One will find a Property Set with the given Id and return the JSON representation of the Property Set. The other will find a list of Property Sets matching the parameters supplied to it.
GET by ID
This GET service will find a Property Set with the given Id and return the JSON representation of the object.
API URL
http://host:port/flexdeploy/rest/v2/administration/propertyset/{Id}
Request
Parameter | Required | Type | Description |
|---|---|---|---|
Id | Yes | URL | URL parameter for the Id which is used to find and return a Property Set |
Response Codes
HTTP Code | Description |
|---|---|
200 | Property Set was found and returned |
400 | Bad request |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
404 | Property Set not found |
500 | Unexpected internal server error |
Example
If we have a Property Set in our database with an Id of 11941 and the following attributes
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v2/administration/propertyset/11941
The GET request would return the following JSON Property Set object
Property Set GET Return JSON
{
"ownerType": "PLUGIN",
"versionNumber": 1,
"isActive": true,
"propertySetName": "installJDevExtension",
"createdOn": "2021-01-28T04:02:08.530+0000",
"createdBy": "autoupload",
"updatedOn": "2021-01-28T04:02:08.546+0000",
"propertySetId": 11941,
"updatedBy": "autoupload",
"ownerId": 122930,
"propertySetKeyDefs": [
{
"versionNumber": 1,
"createdOn": "2021-01-28T04:02:08.530+0000",
"createdBy": "autoupload",
"updatedOn": "2021-01-28T04:02:08.546+0000",
"propertySetId": 11941,
"updatedBy": "autoupload",
"propertyDefinitionId": 11937
},
{
"versionNumber": 1,
"createdOn": "2021-01-28T04:02:08.546+0000",
"createdBy": "autoupload",
"updatedOn": "2021-01-28T04:02:08.546+0000",
"propertySetId": 11941,
"updatedBy": "autoupload",
"propertyDefinitionId": 11938
}
]
}GET by Query Parameters
This GET service will return a list of Property Sets in the form of JSON objects based on the query parameters propertySetId, propertySetName, ownerType, ownerId and isActive. PropertySets 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 Property Sets. The propertySetName parameter returns Property Sets that contain the specified parameter. The other parameters must be equal to the Property Sets.
API URL
http://host:port/flexdeploy/rest/v2/administration/propertyset?
Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters:
propertySetId={propertySetId}
propertySetName={propertySetName}
isActive={isActive}
ownerType={ownerType}
ownerId={ownerId}
Examples:
To Specify the code parameter only:
http://host:port/flexdeploy/rest/v2/administration/propertyset?propertySetId={propertySetId}
To Specify the code and group code parameters:
http://host:port/flexdeploy/rest/v2/administration/propertyset?propertySetId={propertySetId}&propertySetName={propertySetName}
To Specify the name, group code, and sub group code parameters:
http://host:port/flexdeploy/rest/v2/administration/propertyset?propertySetId={propertySetId}&propertySetName={propertySetName}&ownerType={ownerType}
The query parameters are not case sensitive. Searching by propertySetName=NAME is the same as searching by propertySetName=name.
Request
Parameter | Required | Type | Description |
|---|---|---|---|
propertySetId | No | Query - Long | This is a URL query parameter for the Property Set Id which is used to search the Property Sets. Equals search |
propertySetName | No | Query - String | This is a URL query parameter for the Property Set Name which is used to search the Property Sets. Like ignore case search |
ownerType | No | Query - String | This is a URL query parameter for the Owner Type which is used to search the Property Sets. Equals ignore case search |
ownerId | No | Query - Long | This is a URL query parameter for the Owner Id which is used to search the Property Sets. Equals search |
isActive | No | Query - Boolean | This is a URL query parameter for the Is Active which is used to search the Property Sets. Equals search |
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
Output when querying by ownerType through http://host:port/flexdeploy/rest/v2/administration/propertyset?ownerType=TESTING_TOOL
Sample JSON Output
[
{
"ownerType": "TESTING_TOOL",
"versionNumber": 1,
"isActive": true,
"propertySetName": "OATS_TESTING_PS",
"createdOn": "2021-01-22T04:54:46.023+0000",
"createdBy": "autoupload",
"updatedOn": "2021-01-22T04:54:46.033+0000",
"propertySetId": 10032,
"updatedBy": "autoupload",
"ownerId": 10004,
"propertySetKeyDefs": [
{
"versionNumber": 1,
"createdOn": "2021-01-22T04:54:46.027+0000",
"createdBy": "autoupload",
"updatedOn": "2021-01-22T04:54:46.035+0000",
"propertySetId": 10032,
"updatedBy": "autoupload",
"propertyDefinitionId": 10031
}
]
},
{
"ownerType": "TESTING_TOOL",
"versionNumber": 1,
"isActive": true,
"propertySetName": "SOAPUI_TESTING_PS",
"createdOn": "2021-01-22T04:54:46.185+0000",
"createdBy": "autoupload",
"updatedOn": "2021-01-22T04:54:46.197+0000",
"propertySetId": 10041,
"updatedBy": "autoupload",
"ownerId": 10005,
"propertySetKeyDefs": [
{
"versionNumber": 1,
"createdOn": "2021-01-22T04:54:46.190+0000",
"createdBy": "autoupload",
"updatedOn": "2021-01-22T04:54:46.198+0000",
"propertySetId": 10041,
"updatedBy": "autoupload",
"propertyDefinitionId": 10040
}
]
}
]