Versions Compared

Key

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

Property Sets can be accessed through this API using service: GET. This service allow for the retrieval of Property Sets.

...

Info
titleAPI 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}


Tip

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

Request

Parameter
Required
Type
Description
propertySetIdNoQuery - Long

This is a URL query parameter for the Property Set Id which is used to search the Property Sets.

Equals search

propertySetNameNoQuery - String

This is a URL query parameter for the Property Set Name which is used to search the Property Sets.

Like ignore case search

ownerTypeNoQuery - String

This is a URL query parameter for the Owner Type which is used to search the Property Sets.

Equals ignore case search

ownerIdNoQuery - Long

This is a URL query parameter for the Owner Id which is used to search the Property Sets.

Equals search

isActiveNoQuery - Boolean

This is a URL query parameter for the Is Active which is used to search the Property Sets.

Equals search

...

Output when querying by ownerType through http://host:port/flexdeploy/rest/v2/administration/propertyset?ownerType=TESTING_TOOL

Code Block
titleSample 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
            }
        ]        
    }
]

...