REST API - Create an unavailability for a CI

Last modified on 2023/02/21 14:13

Minimum version Service Manager: 2022 - Build 2022.1.109.0.03

POST  /configuration-items/{ci_id}

  • This method allows an unavailability for a specified configuration item (CI) to be created.
        example    /configuration-items/9179
  • To end the CI unavailability: PUT  /configuration-items/{ci_id}. Open url.png See the method.

Notes

      Open url.png  See Service Manager REST API Conventions.

  • You must supply a table in JSON format in the body of the HTTP request.

List of parameters / fields

Mandatory parameters

You must use the parameter below in the URL.

Parameter Type Description / Example
ci_id integer CI identifier

You must use the parameter below in the body of the HTTP request.

Parameter Type Description / Example
start_date date Start of unavailability date

Optional parameters

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

Parameter Type Description / Example
comment string Comment on the CI unavailability
scheduled_date date Scheduled end date of the CI unavailability

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.
Status400
400 Bad Request Request could not be run correctly due to malformed syntax.

example

{
 "error": "Nothing to update (check fieldnames)"
}

or when the "Suspend a ticket" method is called but the ticket is already suspended. The response returned is: { "error": "The request is already suspended. Operation aborted."}

or when the "Reopen a ticket" method is called but the ticket is not suspended. The response returned is: { "error": "The request is not suspended. Operation aborted."}

Status401
401 Unauthorized Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.

example

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

Examples

Example of the body of an HTTP request

{
"unavailable":
    {
     "start_date": "02/16/2022 12:30",
     "comment": "Unavailable via REST"
    }
}

Result with a status code 200 returned

{
"HREF":  "https://{your_server}/api/v1/{your_account}/configuration-items/9179"
}
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 2024