Query records

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 2분
  • Retrieves multiple records from a specified table.

    시작하기 전에

    Role required: sn_cli_metadata.cli_admin, sn_cli_metadata.cli_user, or admin

    프로시저

    Open your system's command-line tool and execute this command.
    $ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table]

    Pass in values for these arguments.

    Parameter Description
    displayValue Include --displayvalue to retrieve the display value from the database for reference and choice fields. Do not include this parameter to retrieve the actual values.
    fields Comma-separated list of field names to return from the database.
    limit Maximum number of records to return.
    offset Starting record index for which to begin retrieving records. Use this value to paginate record retrieval.
    query Required. Encoded query used to filter the result set in the following format: --query '<column_name><operator><value>'.
    table Required. Name of the table in which to query the records.

    $ snc record query --displayvalue --fields short_description,state --query '123TEXTQUERY321=email' --table incident

    The CLI returns any records that match the query.

    {
       "result": [
          {
             "short_description": "Unable to connect to email",
             "state": "Closed"
          }
       ]
    }