REST API - Create a CI
Last modified on 2022/11/08 13:22
Contents
POST /assets
- This method allows a new configuration item (CI) to be created.
- The method supports the creation of a single CI per call.
Notes
See Service Manager REST API Conventions.
- You must supply a table in JSON format in the body of the HTTP request.
- If successful, an HTTP status code 201 is returned and a URL link (HREF) to the created resource is provided.
CommonNotes_JSONandFields
JSON Format / Field Format:
- The field names are those of the Service Manager.data model.
example available_field_1
- To update a field, respect the following JSON format: "field_name":"value".
- JSON object names, including those representing Service Manager database fields, are not case sensitive.
example field_name, Field_Name and FIELD_NAME are equivalent
List of parameters / fields
Mandatory parameters
You must use the parameter below in the body of the HTTP request.
| Parameter | Type | Description / Example |
|---|---|---|
| catalog_id | string | Identifier for the model to which the CI belongs example "catalog_id": 4822 |
| Parameter | Type | Description / Example |
|---|---|---|
| catalog_id | string | Identifier for the model to which the CI belongs example "catalog_id": 4822 |
Optional parameters
None
Optional fields
- You can use all the fields from the AM_ASSET table except those mentioned below in the body of the HTTP request.
- location_code ; location_path
- department_code ; department_path
- In addition to the fields provided by EasyVista, you can also assign values to the fields which you have added to the Service Manager database. These are fields with the prefix e_.
example e_field_name_xyz
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 |
|---|
Status201
| 201 | Created | Request successfully processed and element created. |
Status401
| 401 | Unauthorized | Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.
example { "error": "Invalid Login / Password" } |
Status500
| 500 | Internal Server Error | Generic error message displayed when an unexpected condition is encountered and there is no specific message associated.
example { "error": "An error occured. A text message is returned in the body." } |
Examples
Example of the body of an HTTP request
{
"assets": [
{
"catalog_id": 3153,
"asset_tag": "ZGCSS_732",
"serial_number": "DGSF-2004-1019",
"status_id": 1,
"charge_back": "140",
"installation_date": "09/09/2018",
"IS_CI": 1,
"CI_STATUS_ID": 1,
"comment_asset": "ip_input.c in BSD-derived TCP/IP implementations allows remote attackers to cause a denial of service (crash or hang) via crafted packets."
}
]
}
"assets": [
{
"catalog_id": 3153,
"asset_tag": "ZGCSS_732",
"serial_number": "DGSF-2004-1019",
"status_id": 1,
"charge_back": "140",
"installation_date": "09/09/2018",
"IS_CI": 1,
"CI_STATUS_ID": 1,
"comment_asset": "ip_input.c in BSD-derived TCP/IP implementations allows remote attackers to cause a denial of service (crash or hang) via crafted packets."
}
]
}
Result with a status code 201 returned
{
"HREF": "https://{your_server}/api/v1/{your_account}/assets/9504"
}
"HREF": "https://{your_server}/api/v1/{your_account}/assets/9504"
}
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)" } } |
||