REST API - View the ticket status list


GET  /status

Notes

     Open url.png  See Service Manager REST API Conventions

  • If successful, an HTTP status code 200 is returned.
  • Only an extract of the most useful fields selected by EasyVista is displayed for each record supplied.
    • A URL link (HREF) to each resource is supplied so that the complete list of fields for a record can be obtained if required.

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 /status?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /status?sort=STATUS_EN+desc
fields string Select fields to display.
  • example /status?fields=STATUS_EN,STATUS_FR
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /status?search=STATUS_EN:"Scheduled"
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
    • /status?search=STATUS_EN:"Scheduled",STATUS_EN:"Solved" ==> all the status in which the STATUS_EN field is equal to Scheduled or Solved
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
    • /status?search=STATUS_EN~"Sche*" ==> all the status in which the STATUS_EN field begins with Sche
    • /status?search=STATUS_EN~"*che*" ==> all the status in which the STATUS_EN field contains che
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
    • /status?search=STATUS_EN!~"Sche*" ==> all the status by excluding those in which the STATUS_EN field begins with Sche
    • /status?search=STATUS_EN!~"*che*" ==> all the status by excluding those in which the STATUS_EN field contains che
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 /status?search=STATUS_EN!"Scheduled" ==> all the status by excluding those in which the STATUS_EN field is equal to Scheduled
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
    • /status?search=STATUS_L1:"is_null"&sort=STATUS_ID+asc ==> all the status in whose additionnal language has no value, sorted in ascending STATUS_ID
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
    • /status?search=STATUS_L1:"is_not_null"&sort=STATUS_ID+asc ==> all the status in whose additionnal language has a value, sorted in ascending STATUS_ID

Fields that could be used in optional parameters

You can use all the fields from the AM_STATUS table except those mentioned below.

  • is_help_desk
  • is_procurement
  • is_financial_compted
  • cancel_financial_impact

HTTP status codes for the method

StatusHeader
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"
}
Status404
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.

example

{
 "error": "Resource not found"
}

Examples

Result with a status code 200 returned

{
   "HREF": "https://{your_server}/api/v1/{your_account}/status",
   "record_count": "40",
   "total_record_count": "40",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/1",
           "STATUS_EN": "Scheduled",
           "STATUS_GUID": "{F74C158B-C50F-47C2-B075-096C3ABD71E1}",
           "STATUS_ID": "1"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/2",
           "STATUS_EN": "Solved",
           "STATUS_GUID": "{DC97DD1D-0F35-4153-B0E1-0F2E0155365D}",
           "STATUS_ID": "2"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/3",
           "STATUS_EN": "Escalated",
           "STATUS_GUID": "{AF7C7A5B-D42F-4B40-8368-3500952E7CC5}",
           "STATUS_ID": "3"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/4",
           "STATUS_EN": "Redirected",
           "STATUS_GUID": "{B026A0EC-2507-41DA-A3B2-3D1B5DBCD00E}",
           "STATUS_ID": "4"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/5",
           "STATUS_EN": "On Hold",
           "STATUS_GUID": "{1EBF3D72-C418-4FE0-81F2-3DF87E90951D}",
           "STATUS_ID": "5"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/6",
           "STATUS_EN": "New",
           "STATUS_GUID": "{04296D58-57F3-4906-BAFA-4B60018FC3FA}",
           "STATUS_ID": "6"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/7",
           "STATUS_EN": "Archived",
           "STATUS_GUID": "{57B9F960-4603-4990-8902-5FA2AB214DD9}",
           "STATUS_ID": "7"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/8",
           "STATUS_EN": "Closed",
           "STATUS_GUID": "{C3D9DFA7-7A21-46C2-B3A3-8BC50C9FF4F3}",
           "STATUS_ID": "8"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/9",
           "STATUS_EN": "Pending Validation",
           "STATUS_GUID": "{8FCF87A6-A23A-4394-8FE5-929B9B49D34F}",
           "STATUS_ID": "9"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/10",
           "STATUS_EN": "Accepted",
           "STATUS_GUID": "{A478DE16-FA1A-49A2-A76C-983DD81A6F6C}",
           "STATUS_ID": "10"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/11",
           "STATUS_EN": "Rejected Transition",
           "STATUS_GUID": "{40E8C8B9-1141-480E-826E-A33294D132B6}",
           "STATUS_ID": "11"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/12",
           "STATUS_EN": "In Progress",
           "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
           "STATUS_ID": "12"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/13",
           "STATUS_EN": "Pending Installation",
           "STATUS_GUID": "{D060F58C-8E64-42E0-B942-D408EBE32D19}",
           "STATUS_ID": "13"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/14",
           "STATUS_EN": "Pending Planification",
           "STATUS_GUID": "{A449F42F-E48B-430D-ABF4-D44B009DCF91}",
           "STATUS_ID": "14"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/15",
           "STATUS_EN": "Rejected Operation",
           "STATUS_GUID": "{D63523A6-9659-4CE9-A41F-F6F15653E2C6}",
           "STATUS_ID": "15"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/16",
           "STATUS_EN": "Reopened",
           "STATUS_GUID": "{67FC30D6-06DC-4B75-976F-69BE4CE6BDDD}",
           "STATUS_ID": "16"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/17",
           "STATUS_EN": "Related Incident",
           "STATUS_GUID": "{D137FC26-7FD2-4E7D-9047-4D2F5EDDC73B}",
           "STATUS_ID": "17"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/18",
           "STATUS_EN": "Cancelled",
           "STATUS_GUID": "{6BEFDA82-53EF-400B-84D5-3E020B7B896B}",
           "STATUS_ID": "18"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/19",
           "STATUS_EN": "Attached To A Release",
           "STATUS_GUID": "{FD6E3A77-5ACE-43B4-8C37-3B52742B7725}",
           "STATUS_ID": "19"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/20",
           "STATUS_EN": "Released",
           "STATUS_GUID": "{717252DA-F3FA-4C7A-8C17-90F883AF99E9}",
           "STATUS_ID": "20"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/21",
           "STATUS_EN": "Redirected to a Level Below",
           "STATUS_GUID": "{54C93095-BE13-45C1-87F7-DACCB5648BFB}",
           "STATUS_ID": "21"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/22",
           "STATUS_EN": "On Hold For Completion",
           "STATUS_GUID": "{E9EC0C70-002A-401E-B6FB-F5590A31475F}",
           "STATUS_ID": "22"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/24",
           "STATUS_EN": "Impact Analyzis",
           "STATUS_GUID": "{83CFF134-0E47-4056-8388-81468E740508}",
           "STATUS_ID": "24"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/25",
           "STATUS_EN": "Pending Authorization",
           "STATUS_GUID": "{5AC3236A-DA5E-44D9-802C-6EF34D5556FD}",
           "STATUS_ID": "25"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/26",
           "STATUS_EN": "Pending Evaluation",
           "STATUS_GUID": "{5FCD2CEE-1872-4768-8C8C-30592FE4B9BE}",
           "STATUS_ID": "26"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/27",
           "STATUS_EN": "Pending Acceptance",
           "STATUS_GUID": "{D7478B52-1E4B-4558-A898-35FF49342E07}",
           "STATUS_ID": "27"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/28",
           "STATUS_EN": "Under Development",
           "STATUS_GUID": "{6B240C53-BA0C-45A7-8F5E-28323E5BEF34}",
           "STATUS_ID": "28"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/29",
           "STATUS_EN": "Test Pending",
           "STATUS_GUID": "{18DE9B45-411B-441A-A60C-DA780CD71CB2}",
           "STATUS_ID": "29"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/30",
           "STATUS_EN": "Pending End User",
           "STATUS_GUID": "{6607752E-88EB-4AA2-98B5-0005CA8ED63C}",
           "STATUS_ID": "30"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/33",
           "STATUS_EN": "Rejected by CM",
           "STATUS_GUID": "{9D82D5B6-64C8-4D37-9B54-3B8D22A80699}",
           "STATUS_ID": "33"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/34",
           "STATUS_EN": "Rejected by CAB",
           "STATUS_GUID": "{4F84BFFF-4CB9-455B-9D3B-F5ED6CEE1BDA}",
           "STATUS_ID": "34"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/35",
           "STATUS_EN": "CAB Approval",
           "STATUS_GUID": "{70980CA3-60DE-4945-B18D-120A12B0FD30}",
           "STATUS_ID": "35"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/36",
           "STATUS_EN": "Build",
           "STATUS_GUID": "{001370AF-C333-4A66-8258-1A031B87E3C3}",
           "STATUS_ID": "36"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/37",
           "STATUS_EN": "Test",
           "STATUS_GUID": "{0082B904-7D01-4F85-B7F8-5855B9F3F85E}",
           "STATUS_ID": "37"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/38",
           "STATUS_EN": "Release",
           "STATUS_GUID": "{80F6B145-7F6E-4893-92A8-97357D89D58C}",
           "STATUS_ID": "38"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/39",
           "STATUS_EN": "Review",
           "STATUS_GUID": "{EEFE4C9B-358B-44FF-AB03-7B503E2003C4}",
           "STATUS_ID": "39"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/40",
           "STATUS_EN": "[ -]",
           "STATUS_GUID": "{A58F6615-0971-4712-B6AC-2909BFB80BC1}",
           "STATUS_ID": "40"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/41",
           "STATUS_EN": "Unreviewed",
           "STATUS_GUID": "{0D673188-6AC4-458F-9CFE-890481EB4D6E}",
           "STATUS_ID": "41"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/42",
           "STATUS_EN": "Discovered",
           "STATUS_GUID": "{DA4C79CB-45DF-4B16-9B75-8F119B4A41F5}",
           "STATUS_ID": "42"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/status/43",
           "STATUS_EN": "Quarantined",
           "STATUS_GUID": "{47C7326F-0784-45D9-B704-E32C1CDEB260}",
           "STATUS_ID": "43"
        }
    ]
}


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/2019 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:
Last modified by Unknown User on 2021/09/21 12:15
Created by Administrator XWiki on 2021/09/21 12:15

Shortcuts

Recent changes
•  EV Service Manager
•  Service Apps
•  EV Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021