REST API - View a list of records in an external table

Last modified on 2023/07/17 16:18
Contents

Minimum version Service Manager: Oxygen 1.7 - Build 2018.1.131.0

GET  /E_TEST1

  • This method allows a list of records in an external table E_TABLE to be obtained.
            example   /E_TEST1

Notes

     Open url.png  See Service Manager REST API Conventions

  • The external table must contain a primary key.

List of parameters / fields

Mandatory parameters

None

Optional parameters

You can use the parameters detailed below in the HTTP request string.

Minimum version Parameter Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • example /E_TEST1?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /E_TEST1?sort=employee.last_name+desc
fields string Select fields to display.
  • example /E_TEST1?fields=name
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /E_TEST1?search=search=name:btalma

A search on a Date field is also possible.

  • example /E_TEST1?search=date:last_week
Oxygen 2.1.2 - Build 2018.1.183.0 search

(logical OR operator)

 string Search/filter to several values from a same field
  • Syntax: search=field:value1,field:value2
  • example
    • /E_TEST1?search=location_id:10,location_id:20 ==> all the records in which the location_id field is equal to 10 or 20
Oxygène 1.7 - Build 2018.1.131.0 ~

(equivalent to like)

 string Include the results which begin with or contain a given character string.
  • Syntax: ~ following by the string to include enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = include what begins with < string >.
    • *< string >* = include what contains < string >.
  • example
    • /E_TEST1?search=the_resource_name!~"tes*" ==> all the records in which the the_resource_name field begins with tes
    • /E_TEST1?search=the_resource_name!~"*tes*" ==> all the records in which the the_resource_name field contains tes
!~

(equivalent to not like)

 string Exclude the results which begin with or contain a given character string.
  • Syntax: !~ following by the string to exclude enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = exclude what begins with < string >.
    • *< string >* = exclude what contains < string >.
  • example
    • /E_TEST1?search=the_resource_name!~"tes*" ==> all the records by excluding those in which the the_resource_name field begins with tes
    • /E_TEST1?search=the_resource_name!~"*tes*" ==> all the records by excluding those in which the the_resource_name field contains tes
Oxygen 1.7 - Build 2018.1.131.0 !

(equivalent to not)

 string Exclude all results equal to a given character string.
  • Syntax: ! following by the string to exclude enclosed in quotation marks.
  • example /E_TEST1?search=the_resource_name!"test2" ==> all the records by excluding those in which the the_resource_name field is equal to test2
Oxygen 2.1.2 - Build 2018.1.183.0 is_null string Retrieve all results in which the field has no value (field value = null)
  • Syntax: Field name following by "is_null"
  • example
    • /E_TEST1?search=end_date_ut:"is_null"&sort=test_id+asc ==> all the records in which the end date has no value, sorted in ascending identifier
Oxygen 2.1.2 - Build 2018.1.183.0 is_not_null string Retrieve all results in which the field has a value (field value = not null)
  • Syntax: Field name following by "is_not_null"
  • example
    • /E_TEST1?search=end_date_ut:"is_not_null"&sort=test_id+asc ==> all the records in which the end date has a value, sorted in ascending identifier
Oxygen 1.7 - Build 2018.1.131.0 formatDate string Format display of Date fields in the HTTP request result.   Open url.png See Description of the options.
  • example
    • /E_TEST1?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /E_TEST1?fields=last_update&formatDate=l jS \of F Y h:i:s A ==> "last_update_format": "Friday 16th of November 2018 12:00:00 AM"

Fields that could be used in optional parameters

You can use all the fields from the external table E_TABLE.

HTTP status codes for the method

StatusHeader

   A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).

Code Error Description
Status200
200 OK (Successful) Request successfully processed.
Status401
401 Unauthorized Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.

example

{
 "error": "Invalid Login / Password"
}

Example

Result for 2 records (status code 200)

{
   "record_count": "2",
   "total_record_count": "2",
   "records": [
        {
           "TEST_ID": "2",
           "HREF": " http://{your_server}/api/v1/40000/e_test1/2",
           "THE_RESOURCE_NAME": "test2",
           "THE_XML": {
               "HREF": " http://{your_server}/api/v1//{your_account}//e_test1/2/the_xml"
            }
        },
        {
           "TEST_ID": "4",
           "HREF": "/api/v1/40000/e_test1/4",
           "THE_RESOURCE_NAME": "test4",
           "THE_XML": {
               "HREF": " http://{your_server}/api/v1//{your_account}//e_test1/4/the_xml"
            }
        }
    ],
   "HREF": "http://{your_server}/api/v1/{your_account}/e-test1/"
}
ConventionsAPI

REST API Conventions

Convention Meaning
Orange Parameters used in an HTTP request string which do not correspond to Service Manager database fields.

example   Method View a list of assets

https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag
Black and Bold Parameters used in the URL of an HTTP request which correspond to Service Manager database fields.

example   Method View an asset

https://{your_server}/api/v1/{your_account}/assets/{asset_id}
Green Parameters used in the body of an HTTP request which represent JSON object names corresponding to Service Manager database fields; they allow the value of a database field to be assigned or modified.

example   Method Close an incident/request

{  "closed": {  "end_date": "11/20/2016 12:12:12",  }  }
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields.

example   Method Reopen an incident/request

{  "restarted": {  "comment": "string (required)"  }  }
Tags:
Powered by XWiki © EasyVista 2022