List Property Groups Using GET

List Property Groups Using GET

Lists Property Groups

Request
URI
GET
https://{api_host}/properties/api/property-groups
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer
size
Optional
Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array
sort
Optional
Constraints: default: updatedAt,DESC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string of array
$select
Optional

Fields to include.

string
name
Optional

Filter by name

string
type
Optional

Filter by type

Possible values are : INPUT, CONSTANT,
string
search
Optional

Search by name and description

string of array
projects
Optional

A comma-separated list. Results must be associated with one of these project IDs.

string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

integer
$top
Optional

Number of records you want

$top example
1
integer
$skip
Optional

Number of records you want to skip

$skip example
1
string
$orderby
Optional

Sorting criteria in the format: property (asc|desc). Default sort order is descending on updatedAt. Sorting is supported on fields createdAt, updatedAt, createdBy, updatedBy, name, type.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagePropertyGroup of type(s) application/json 
{
    "content": [
        {
            "createdAt": "string",
            "createdBy": "string",
            "description": "string",
            "displayName": "string",
            "id": "string",
            "name": "string",
            "orgId": "string",
            "projectId": "string",
            "projectName": "string",
            "properties": {
                "properties": {
                    "$dynamicDefault": "string",
                    "$dynamicEnum": "string",
                    "const": {},
                    "default": {},
                    "description": "string",
                    "encrypted": false,
                    "enum": [
                        {}
                    ],
                    "format": "string",
                    "items": "Property Object",
                    "maxItems": 0,
                    "maxLength": 0,
                    "maximum": 0,
                    "minItems": 0,
                    "minLength": 0,
                    "minimum": 0,
                    "oneOf": [
                        "Property Object"
                    ],
                    "pattern": "string",
                    "properties": {
                        "properties": "Property Object"
                    },
                    "readOnly": false,
                    "title": "string",
                    "type": "string"
                }
            },
            "type": "string",
            "updatedAt": "string",
            "updatedBy": "string"
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": {
            "empty": false,
            "sorted": false,
            "unsorted": false
        },
        "unpaged": false
    },
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "totalElements": 0,
    "totalPages": 0
}
array of object
content
Optional

content

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/properties/api/property-groups
On This Page
Property Groups Operations
GET
List Property Groups Using GET
POST
Create Property Group Using POST
DELETE
Delete Property Group Using DELETE
GET
Get Property Group Using GET
PUT
Update Property Group Using PUT