Crasman Help
POST search
Hakee tiedostoja hakuehdoin. Mahdollisuus käyttää yksittäisen metatietokannan kenttiä, tai tiedoston perustietoja ehtoina.
Parametrit
Ottaa vastaan JSON-muotoillun datan, jossa päätason avaimina mahdollista käyttää oheisia:
| Avain | Selite |
| limit |
Kuinka monta hakutulosta palautetaan Esimerkkiarvo: 500 |
| offset |
Hakutuloksen alkukohta Esimerkkiarvo: 0 |
| dbLang |
Käytettävä stage-tietokannan kieli. Pakollinen käytettäessä db-ehtoa. Esimerkkiarvo: fi_Fi |
| db |
Hakuehdot stage-tietokantataulua varten Esimerkkiarvo: {"metadata":{"sku":{"oper":"truthy","value":""},"updated":{"oper":"gte","value":"2020-03-19 12:29:54"}} |
| name |
Hakuehto: tiedoston nimi Esimerkkiarvo: {"oper":"ends","value":"jpg"}
|
| description | Hakuehto: tiedoston kuvaus |
| createdAt | Hakuehto: tiedoston luontiaika |
| modifiedAt | Hakuehto: tiedoston muokkausaika |
| folderId | Hakuehto: kansionId, jossa tiedosto sijaitsee |
| binModifiedAt | Hakuehto: tiedoston sisällön muokkausaika |
| tagId | Hakuehto: tagitettujen tiedostojen tagin id (vaihtoehtoinen tagName kanssa) |
| tagName | Hakuehto: tagitettujen tiedostojen tagin arvo (vaihtoehtoinen tagId kanssa) |
| recursive | Jos käytössä, niin hakee rekursiivisesti tiedostoja folderId-tiedolla annetun kansion alaisuudesta |
Hakuoperaattorit:
| Operaattori | Selite |
| eq | yhtä suuri kuin |
| neq | eri suuri kuin |
| gt | suurempi kuin |
| gte | suurempi tai yhtä suuri kuin |
| lt | pienempi kuin |
| lte | pienempi tai yhtä suuri kuin |
| begins | alkaa |
| ends | loppuu |
| contains | sisältää |
| falsy | (vain stage-tietokantataulu) |
| truthy | (vain stage-tietokantataulu) |
Esimerkki
POST https://acme.studio.crasman.fi/studioapi/v2/search
{"dbLang":"fi_FI","db":{"metadata":{"sku":{"oper":"falsy","value":""},"updated":{"oper":"gte","value":"2020-03-19 12:29:54"}}},"name":{"oper":"ends","value":"jpg"},"limit":1000,"offset":0}
POST https://acme.studio.crasman.fi/studioapi/v2/search
{"tagName": {"oper": "eq", "value": "Yellow Images"},"binModifiedAt":{"value":1726044259,"oper":"gte"}}
Paluuarvo
{
"status": "ok",
"result": [
{
"id": "66e1586d0212b4400a06b5c0",
"name": "020.jpg",
"size": 18661,
"createdAt": 1726044269,
"details": {
"md5": "6d79ab586b5a7a2a4201fa99d585b58c",
"sha1": "ee7d9813a15de6aa4cd59a053583e75665593533"
},
"keywords": [],
"binModifiedAt": 1726044269
}
],
"code": 0
}