Search for keys

GET 
/v2/projects/:projectId/keys/search

This endpoint helps you to find desired key by keyName, base translation or translation in specified language.

Request

Path Parameters

projectId int64required

Query Parameters

search stringrequired

Search query

languageTag string

Language to search in

page integer

Default value: 0

Zero-based page index (0..N)

size integer

Possible values: >= 1

Default value: 20

The size of the page to be returned

sort string[]

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

Responses

200

OK

application/json

Schema

Schema

_embedded object
keys object[]
Array [
view object
translation string
baseTranslation string
namespace string
description string
name stringrequired
id int64required
translation string
baseTranslation string
namespace string
description string
name stringrequired
id int64required
]
page object
size int64
totalElements int64
totalPages int64
number int64

Example (from schema)

{
  "_embedded": {
    "keys": [
      {
        "view": {
          "translation": "string",
          "baseTranslation": "string",
          "namespace": "string",
          "description": "string",
          "name": "string",
          "id": 0
        },
        "translation": "string",
        "baseTranslation": "string",
        "namespace": "string",
        "description": "string",
        "name": "string",
        "id": 0
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...