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

Authentication - Use Basic Authentication for this API.

GET

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

GET by ID

This GET service will find a Property Key Definitions with the given Id and return the JSON representation of the object.

API URL

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

Request

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

Response Codes

HTTP Code	Description
200	Property Key Definition was found and returned
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	Property Key Definition not found
500	Unexpected internal server error

Example

If we have a Property Key Definition in our database with an Id of 11652 and the following attributes

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v2/administration/propertykeydefinition/11652

The GET request would return the following JSON Property Key Definition object

Property Key Definition GET Return JSON

{
    "length": null,
    "defaultValue": null,
    "displayName": "AWS Secret Key",
    "minValue": null,
    "maxValue": null,
    "isRequired": true,
    "description": "The secret key associated with your AWS account and endpoint.",
    "versionNumber": 1,
    "isActive": true,
    "createdOn": "2021-01-28T04:00:28.543+0000",
    "createdBy": "autoupload",
    "isCustom": false,
    "isMultiselect": false,
    "updatedOn": "2021-01-28T04:00:30.015+0000",
    "sortNumber": 2200,
    "isEncrypted": true,
    "updatedBy": "autoupload",
    "propertyDefinitionId": 11652,
    "propertyKeyName": "FDAWS_SECRET_KEY",
    "isAllowsVariant": false,
    "isDefaultExpression": false,
    "displayColumns": null,
    "validator1": null,
    "validator2": null,
    "validator4": null,
    "validator3": null,
    "validator5": null,
    "displayRows": null,
    "propertyScope": "ENVINST",
    "listData": null,
    "propertyKeyDatatype": "String",
    "propertyKeySubDatatype": null
}

GET by Query Parameters

This GET service will return a list of Property Key Definitions in the form of JSON objects based on the query parameters propertyDefinitionId, propertyKeyName, displayName, propertyScope, description, isCustom, isMultiSelect, isAllowsVariant, isDefaultExpression and isActive. Property Key Definitions 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 Key Definitions. The propertyKeyName parameter returns Property Key Definitions that contain the specified parameter. The other parameters must be equal to the Property Key Definitions.

API URL

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

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

Use '&' between successive query parameters:

propertyDefinitionId={propertyDefinitionId}

propertyKeyName={propertyKeyName}

isActive={isActive}

displayName={displayName}

propertyScope={propertyScope}

isCustom={isCustom}

description={description}

isAllowsVariant={isAllowsVariant}

isMultiSelect={isMultiSelect}

isDefaultExpression={isDefaultExpression}

Examples:

To Specify the code parameter only:

http://host:port/flexdeploy/rest/v2/administration/propertykeydefinition?propertyDefinitionId={propertyDefinitionId}

To Specify the code and group code parameters:

http://host:port/flexdeploy/rest/v2/administration/propertykeydefinition?propertyDefinitionId={propertyDefinitionId}&propertyKeyName={propertyKeyName}

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

http://host:port/flexdeploy/rest/v2/administration/propertykeydefinition?propertyDefinitionId={propertyDefinitionId}&propertyKeyName={propertyKeyName}&description={description}

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

Request

Parameter	Required	Type	Description
propertyDefinitionId	No	Query - Long	This is a URL query parameter for the Property Definition Id which is used to search the Property Key Definitions. Equals search
propertyKeyName	No	Query - String	This is a URL query parameter for the Property Key Name which is used to search the Property Key Definitions. Like ignore case search
description	No	Query - String	This is a URL query parameter for the Description which is used to search the Property Key Definitions. Equals ignore case search
displayName	No	Query - String	This is a URL query parameter for the Display Name which is used to search the Property Key Definitions. Equals search
isActive	No	Query - Boolean	This is a URL query parameter for the Is Active which is used to search the Property Key Definitions. Equals search
isCustom	No	Query - Boolean	This is a URL query parameter for the Is Custom which is used to search the Property Key Definitions. Equals search
isAllowsVariant	No	Query - Boolean	This is a URL query parameter for the Is Allows Variant which is used to search the Property Key Definitions. Equals search
isMultiSelect	No	Query - Boolean	This is a URL query parameter for the Is Multi Select which is used to search the Property Key Definitions. Equals search
isDefaultExpression	No	Query - Boolean	This is a URL query parameter for the Is Default Expression which is used to search the Property Key Definitions. Equals search
propertyScope	No	Query - String	This is a URL query parameter for the Property Scope which is used to search the Property Key Definitions. Like ignore case 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 isActive through http://host:port/flexdeploy/rest/v2/administration/propertykeydefinition?isActive=false

Sample JSON Output

[
    {
        "length": null,
        "defaultValue": null,
        "displayName": "Jira Port",
        "minValue": null,
        "maxValue": null,
        "isRequired": false,
        "description": "Jira Port",
        "versionNumber": 1,
        "isActive": false,
        "createdOn": "2021-01-22T04:54:46.538+0000",
        "createdBy": "autoupload",
        "isCustom": false,
        "isMultiselect": false,
        "updatedOn": "2021-01-22T04:54:46.591+0000",
        "sortNumber": 10,
        "isEncrypted": false,
        "updatedBy": "autoupload",
        "propertyDefinitionId": 10058,
        "propertyKeyName": "JIRA_PORT",
        "isAllowsVariant": false,
        "isDefaultExpression": false,
        "displayColumns": null,
        "validator1": null,
        "validator2": null,
        "validator4": null,
        "validator3": null,
        "validator5": null,
        "displayRows": null,
        "propertyScope": "INST",
        "listData": null,
        "propertyKeyDatatype": "Integer",
        "propertyKeySubDatatype": null
    }
]

Browser not supported