Fejlesztői kézikönyv 6.4

XML Referencia 6.4

Effector Studio 6.4 összefoglaló

Effector Studio 6.4 kézikönyv

Effector WebAPI 6.4 kézikönyv

Fejlesztői kézikönyv 6.3

XML Referencia 6.3

Effector Studio 6.3 összefoglaló

Effector Studio 6.3 kézikönyv

XML Referencia 6.2

Effector Studio 3.2 összefoglaló

Effector Studio 3.2 kézikönyv

Üzleti objektumok keresése

Leírás

A Data.BusinessObject entitások közül meg lehet keresni a megadott feltételnek megfelelőket. Ez egy gyűjteményhez kötött művelettel végezhető el az Effector API-ban.

Művelet

[GET] /api/BusinessObjects/Data.TypeItems(type='{type}',subType='{subType}')?$filter={OData filter expression}

Paraméterek

  • type: típus (pl.: Event, Project). Kötelező paraméter.
  • subType: altípus (pl.: folyamatlépés neve)
  • OData filter expression: Odata v4-nek megfelelő szűrési kifejezés. Az Data/{field name} lekérdezésben való megadásával adatokra is lehet szűrni. Megadása kötelező.

Válasz

Sikeres lekérdezés esetén egy, a szűrési feltételeknek megfelelő Data.BusinessObject objektumokból álló lista kerül visszaadásra.

Példa

BusinessObjectSomethingSample.xml

<BusinessObject xmlns="http://effector.hu/schema/ns/businessobject">
<ParentBusinessObject>BusinessObjectSomething</ParentBusinessObject>
<DataTable>Something</DataTable>
<UniqueIDColumn>SomethingID</UniqueIDColumn>
...
<Fields>
<Field name="EncryptionType" foreignField="AForeignField" />
<Field name="IntDbField" />
<Field name="VarcharDbField" />
<Field name="Created" />
</Fields>
</BusinessObject>

Kérés

GET /BusinessObjects/Data.TypeItems(type='Something',subType='Sample')?$filter=Data/Created lt 2019-12-18T11:44:25.9813049%2B01:00 HTTP/1.1
Host: http://myeffectorapp.mydomain.com/api/
Authorization: Bearer 592580a9-4c07-4b65-89eb-a7286a017e08
Cookie: EffectorSessionID=4c510a19-9c50-4115-b385-3f4d2ec3807b

Válasz

HTTP/1.1 200 OK
OData-Version: 4.0
Content-Type: application/json; odata.metadata=minimal
Date: Fri, 17 Jan 2020 16:17:55 GMT

{
"value": [
{
"BoType": "Something",
"BoTemplate": "Sample",
"ObjectID": 1,
"WorkflowID": null,
"DefaultTable": "Something",
"UniqueID": "SomethingID",
"ParentWorkflowID": null,
"SubWorkflowID": null,
"ParentBoType": null,
"ParentBoTemplate": null,
"ParentObjectID": null,
"Guid": null,
"Deleted": 0,
"Data": {
"EncryptionType": "sample value",
"IntDbField": 42,
"VarcharDbField": "text",
"Created": "2019-11-04T13:06:00+01:00"
}
},
{
"BoType": "Something",
"BoTemplate": "Sample",
"ObjectID": 1,
"WorkflowID": null,
"DefaultTable": "Something",
"UniqueID": "SomethingID",
"ParentWorkflowID": null,
"SubWorkflowID": null,
"ParentBoType": null,
"ParentBoTemplate": null,
"ParentObjectID": null,
"Guid": null,
"Deleted": 0,
"Data": {
"EncryptionType": "another sample value",
"IntDbField": 1337,
"VarcharDbField": "different text",
"Created": "2019-10-05T13:06:00+01:00"
}
}
]
}

Szűrő

A $filter szűrő opció lehetővé teszi URL kérés által megcímzett erőforrás gyűjtemények szűrését. A $filter-ben megadott kifejezés a gyűjtemény minden erőforrásában kiértékelésre kerül (true vagy false) és csak az annak megfelelőek kerülne bele a válaszba. A keresési kifejezésnek nem megfelelő vagy jogosultság miatt nem elérhető erőforrások kihagyásra kerülnek.

Szűrő operátorok

Az OData meghatározza logikai operátorok egy halmazát, amelyek true-ra vagy false-ra értékelnek (OData-ABNF-ben definiált boolCommonExpr). A logikai operátorok jellemzően erőforrás-gyűjtemények szűrésére használatosak.

Szűrő operátor példák

  • Egyenlőség: Az eq operátor true-val tér vissza, ha a bal oldali operandus egyenlő a jobb oldalival. Minden más esetben false-szal.
  • Nagyobb mint: A gt operátor true-val tér vissza, ha a bal oldali operandus nagyobb, mint a jobb oldali. Minden más esetben false-szal.
  • Kisebb mint: Az lt operátor true-val tér vissza, ha a bal oldali operandus kisebb, mint a jobb oldali. Minden más esetben false-szal.

A szűrő operátorok részletes leírása az alábbi oldalon található: http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part2-url-conventions/odata-v4.0-errata02-os-part2-url-conventions-complete.html#_Toc406398094

Példák hibaesetekre

Nem létező BoType vagy BoTemplate esetén

HTTP/1.1 400 Bad Request

{
"error": {
"code": "200724152915.8782",
"message": "Bad request",
"target": "",
"details": {},
"innererror": {}
}
}

$filter vagy szűrő kifejezés nélküli kérés, illetve hiányzó BoType esetén

HTTP/1.1 400 Bad Request

{
"error": {
"code": "200717092614.0883",
"message": "Missing required property",
"target": "",
"details": {},
"innererror": {}
}
}

  • Legutóbb frissítve: 10 hét 1 napja
  • Effector