REST API - View a list of actions

Last modified on 2022/11/08 13:22
Contents

Minimum version Service Manager: Oxygen 1.7 - Build 2018.1.131.0

GET  /actions

  • This method allows a list of actions to be obtained.

Notes

       Open url.png  See Service Manager REST API Conventions

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 /actions?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /actions?sort=action_id+desc
fields string Select fields to display.
  • example /actions?fields=action_id,action_label_en
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /actions?search=action_label_en:"Call"

A search on a Date field is also possible.

  • example /actions?search=creation_date_ut: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
    • /actions?search=action_type_id:1,action_type_id:20 ==> all the actions in which the action type is equal to 1 or 20
    • /actions?search=action_type_id:1,action_type_id:20,done_by_id:18376 ==> only the actions attached to the 18376 user and in which the action type is equal to 1 or 20
Oxygen 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
    • /actions?search=action_label_en~"Cal*" ==> all the actions in which the action_label_en field begins with Cal
    • /actions?search=action_label_en~"*Cal*" ==> all the actions in which the action_label_en field contains Cal
Oxygen 1.7 - Build 2018.1.131.0 !~

(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
    • /actions?search=action_label_en!~"Cal*" ==> all the actions by excluding those in which the action_label_en field begins with Cal
    • /actions?search=action_label_en!~"*Cal*" ==> all the actions by excluding those in which the action_label_en field contains Cal
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 /actions?search=action_label_en!"Call" ==> all the actions by excluding those in which the action_label_en field is equal to Call
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
    • /actions?search=end_date_ut:"is_null" ==> all the actions in which the end date has no value
    • /actions?search=end_date_ut:"is_null",done_by.e_mail:morley@evtry.com&sort=action_id+asc ==> only the actions attached to the user morley 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
    • /actions?search=end_date_ut:"is_not_null" ==> all the actions in which the end date has a value
    • /actions?search=end_date_ut:"is_not_null",done_by.e_mail:morley@evtry.com&sort=action_id+asc ==> only the actions attached to the user morley 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
    • /actions?fields=end_date_ut&formatDate=l/M/Y ==> "end_date_ut_format": "Friday/Nov/2018"
    • /actions?fields=end_date_ut&formatDate=l jS \of F Y h:i:s A ==> "end_date_ut_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 AM_ACTION table.

HTTP status codes for the method

StatusHeader

Note: 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 (Success) Request processed successfully.
Status401
401 Unauthorized Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect Service Manager account.

example

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

Example

Result for 5 actions (status code 200)

{
   "HREF": "http://{your_server}/api/v1/{your_account}/actions?max_rows=5"
   "record_count": "5",
   "total_record_count": "3136",
   "records": [
        {
           "ACTION_ID": "54538",
           "HREF": "https://{your_server}/api/v1/{your_account}actions/54538",
           "ACTION_LABEL_FR": "Appel",
           "ACTION_NUMBER": "",
           "DONE_BY_ID": "10469",
           "EXPECTED_START_DATE_UT": "",
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "France",
               "LOCATION_PATH": "Europe/France",
               "LOCATION_ID": "63"
            },
           "DONE_BY": {
               "BEGIN_OF_CONTRACT": "1985-10-24",
               "CELLULAR_NUMBER": "783-364-353",
               "DEPARTMENT_PATH": "DSI/Support",
               "E_MAIL": "leblanc@evtry.com",
               "EMPLOYEE_ID": "10469",
               "LAST_NAME": "Leblanc, Fred",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/109",
               "PHONE_NUMBER": "+33155859633"
            },
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "2008-03-31T15:55:40.000+02:00",
               "RFC_NUMBER": "I080104_000002",
               "SUBMIT_DATE_UT": "2008-03-28T14:55:39.000+01:00"
            },
           "ACTION_TYPE": {
               "ACTION_TYPE_ID": "7",
               "NAME_EN": "Call Reception"
            }
        },
        {
           "ACTION_ID": "54539",
           "HREF": "https://{your_server}/api/v1/{your_account}/actions/54539",
           "ACTION_LABEL_FR": "Appel",
           "ACTION_NUMBER": "",
           "DONE_BY_ID": "16708",
           "EXPECTED_START_DATE_UT": "",
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "-",
               "LOCATION_PATH": "",
               "LOCATION_ID": "6"
            },
           "DONE_BY": {
               "BEGIN_OF_CONTRACT": "2003-02-13",
               "CELLULAR_NUMBER": "784-464-904",
               "DEPARTMENT_PATH": "Ventes/Direct/Support client",
               "E_MAIL": "eleblanc@evtry.com",
               "EMPLOYEE_ID": "16708",
               "LAST_NAME": "Leblanc, Eric",
               "LOCATION_PATH": "Amérique du Nord/Canada/Toronto/Bat.1/Etage 01/139",
               "PHONE_NUMBER": "(905) 501 -  2962"
            },
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "2008-03-31T16:00:32.000+02:00",
               "RFC_NUMBER": "I080104_000003",
               "SUBMIT_DATE_UT": "2008-03-28T15:00:32.000+01:00"
            },
           "ACTION_TYPE": {
               "ACTION_TYPE_ID": "7",
               "NAME_EN": "Call Reception"
            }
        },
        {
           "ACTION_ID": "54540",
           "HREF": "https://{your_server}/api/v1/{your_account}/actions/54540",
           "ACTION_LABEL_FR": "Analyse et résolution",
           "ACTION_NUMBER": "0",
           "DONE_BY_ID": "10469",
           "EXPECTED_START_DATE_UT": "2008-06-04T16:41:04.000+02:00",
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "-",
               "LOCATION_PATH": "",
               "LOCATION_ID": "6"
            },
           "DONE_BY": {
               "BEGIN_OF_CONTRACT": "1985-10-24",
               "CELLULAR_NUMBER": "783-364-353",
               "DEPARTMENT_PATH": "DSI/Support",
               "E_MAIL": "leblanc@evtry.com",
               "EMPLOYEE_ID": "10469",
               "LAST_NAME": "Leblanc, Fred",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/109",
               "PHONE_NUMBER": "+33155859633"
            },
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "2008-03-31T16:00:32.000+02:00",
               "RFC_NUMBER": "I080104_000003",
               "SUBMIT_DATE_UT": "2008-03-28T15:00:32.000+01:00"
            },
           "ACTION_TYPE": {
               "ACTION_TYPE_ID": "20",
               "NAME_EN": "Operation Action"
            }
        },
        {
           "ACTION_ID": "54541",
           "HREF": "https://{your_server}/api/v1/{your_account}/actions/54541",
           "ACTION_LABEL_FR": "Notification au demandeur",
           "ACTION_NUMBER": "0",
           "DONE_BY_ID": "13797",
           "EXPECTED_START_DATE_UT": "",
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "-",
               "LOCATION_PATH": "",
               "LOCATION_ID": "6"
            },
           "DONE_BY": {
               "BEGIN_OF_CONTRACT": "1992-07-07",
               "CELLULAR_NUMBER": "789-989-269",
               "DEPARTMENT_PATH": "Ventes/Direct/Industrie",
               "E_MAIL": "morley@evtry.com",
               "EMPLOYEE_ID": "13797",
               "LAST_NAME": "Morley, Frédérique",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/111",
               "PHONE_NUMBER": "+33155859641"
            },
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "2008-03-31T16:00:32.000+02:00",
               "RFC_NUMBER": "I080104_000003",
               "SUBMIT_DATE_UT": "2008-03-28T15:00:32.000+01:00"
            },
           "ACTION_TYPE": {
               "ACTION_TYPE_ID": "18",
               "NAME_EN": "Send Email"
            }
        },
        {
           "ACTION_ID": "54562",
           "HREF": "https://{your_server}/api/v1/{your_account}/actions/54562",
           "ACTION_LABEL_FR": "Affectation",
           "ACTION_NUMBER": "",
           "DONE_BY_ID": "10105",
           "EXPECTED_START_DATE_UT": "",
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "-",
               "LOCATION_PATH": "",
               "LOCATION_ID": "6"
            },
           "DONE_BY": {
               "BEGIN_OF_CONTRACT": "1997-09-21",
               "CELLULAR_NUMBER": "787-760-337",
               "DEPARTMENT_PATH": "DSI/Support",
               "E_MAIL": "lewis@evtry.com"
               "EMPLOYEE_ID": "10105",
               "LAST_NAME": "Lewis, Fabienne",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/111",
               "PHONE_NUMBER": "+33155859638"
            },
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "2008-03-31T16:00:32.000+02:00",
               "RFC_NUMBER": "I080104_000003",
               "SUBMIT_DATE_UT": "2008-03-28T15:00:32.000+01:00"
            },
           "ACTION_TYPE": {
               "ACTION_TYPE_ID": "64",
               "NAME_EN": "Assignment"
            }
        }
    ],
}
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