エンティティ レコードにクエリを実行

エンティティのレコードにクエリを実行します。

API エンドポイント

BaseURL/EntityService/<Entity>/query

• BaseURL:

要求ヘッダー

ヘッダー	値 (Value)
認可	Bearer <access_token>
Content-Type	application/json

注:

角括弧で囲まれた値 <...> をすべて、対応するユース ケース値に置き換えます。

<access_token> は、外部アプリケーションの認証時に受け取ったトークンです。このトークンは 1 時間利用可能です。1 時間経ったら、新しいトークンを生成するか、更新トークンを要求する必要があります。

Query Parameters

クエリ パラメーター	データ型	説明	既定値
expansionLevel (任意)	int32	取得する関連レコードの深さを指定します。このパラメーターには 1、2、または 3 のいずれかの値を指定できます。	2

要求本文 (必須)

{
  "selectedFields": [
    "string"
  ],
  "filterGroup": {
    "logicalOperator": 0,
    "queryFilters": [
      {
        "fieldName": "string",
        "operator": "string",
        "value": "string"
      }
    ],
    "filterGroups": [
      null
    ]
  },
  "start": 0,
  "limit": 0,
  "sortOptions": [
    {
      "fieldName": "string",
      "isDescending": true
    }
  ]
}

要求本文のスキーマ

query エンドポイントの要求本文は、以下のコンポーネントから成ります。

selectedFields

これは、string 型の任意のコンポーネントです。クエリの各レコードに対して返されるフィールドのリストを指定します。何も指定しない場合、またはクエリ リストが空の場合は、すべてのレコード フィールドが返されます。既定値は null です。

filterGroup

これは、クエリのフィルター処理プロパティを設定するのに役立つ、必須のコンポーネントです。以下のプロパティを組み合わせます。

• logicalOperator - これは、int32 型の、filterGroup の任意のプロパティです。すべてのフィルターおよびフィルター グループをクエリに適用するかどうかを指定します。すべてのフィルターとフィルター グループを適用するには、0 を使用します。任意のフィルターとフィルター グループを適用するには、1 を使用します。既定値は 0 です。

• queryFilter - フィルター処理の式を定義するのに役立つ、filterGroup の必須のプロパティです。以下のプロパティがあります。

  queryFilter のプロパティ	データ型	説明
  fieldName	string	フィルター処理するフィールドの名前を指定します。
  operator	string	フィルター演算子を指定します。以下の演算子をサポートしています。 contains、not contains、startswith、endswith、=、!=、>、<,>=、<=、in、not in。対応するフィールドの型に対する適切な演算子を使用します。
  value	string	フィルター値を指定します。

• filterGroups - これは filterGroup の任意のプロパティです。クエリに別のフィルター オプションを設定する必要がある場合に指定します。上記の filterGroup のプロパティがすべて含まれます。

開始

これは、int32 型の任意のコンポーネントです。クエリからレコードを取得する前にスキップするレコードの数を指定します。limit プロパティと併用してページネーションを実装できます。レコードは ID の昇順に並べられます。並べ替えの順序を変更するには、sortOptions プロパティを使用します。既定値は 0 です。

limit

これは、int32 型の任意のコンポーネントです。エンティティから読み取るレコードの最大数を指定します。start プロパティと併用してページネーションを実装できます。既定値は 100 で、最大値は 1000 です。

sortOptions

これは任意のコンポーネントであり、クエリが実行されたレコードをフィールドのリストで並べ替える際に役立ちます。空のままにすると、レコードは ID の昇順に並べ替えられます。以下のプロパティを組み合わせます。

• fieldName - これは、string 型の、sortOptions の必須のプロパティです。レコードの並べ替えに使用するフィールドの名前を指定します。この名前は有効なフィールドに対応している必要があり、大文字と小文字が区別されます。
• isDescending - これは、boolean 型の、sortOptions の任意のプロパティです。レコードを降順に並べ替える場合は true に設定します。既定値は false です。

応答

200 OK

{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:21:22.771Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:21:22.771Z"
    }
  ]
}

応答本文のスキーマ

query エンドポイントの応答本文は、以下のコンポーネントから成ります。

• totalRecordCount - 指定したクエリ フィルターに一致するレコードの総数です。
• value - limit プロパティにより制限される、指定したクエリ フィルターに一致するエンティティ レコードの配列です。

401 未承認

Data Service へのアクセスが認証されていません。お使いのアカウントのモダン フォルダーに Assistant またはロボットが接続されていることをご確認ください。

403 Forbidden

エンティティ、フィールド、またはレコードにアクセスする権限がありません。または、サポートされていない種類のロボットを使用しています。必要な権限について管理者にお問い合わせください。