Page Comparison

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

...

Info

title	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}

Tip
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

...

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

Code Block

title	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
    }
]

...

Versions Compared

Old Version 1

New Version Current

Key