MyCSI API - Documentation

POST CMDB/Asset/{id}

Method used via a CMDB to create a new Asset or update an existing one.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Security token provided via the Authentication method.	globally unique identifier	Required

Body Parameters

Asset to insert or update.

CMDB_Asset

Name	Description	Type	Additional information
CMDB_ID	Unique identifier of Asset, provided by the calling Content Management Database.	string	Required Max length: 256
Schedule	Schedule to which the Asset belongs.	string	Required Max length: 32
Serial	Serial number of the Asset.	string	Required Max length: 64
CDF01	Customer Defined Field - 1.	string	Max length: 50
CDF02	Customer Defined Field - 2.	string	Max length: 50
CDF03	Customer Defined Field - 3.	string	Max length: 50
CDF04	Customer Defined Field - 4.	string	Max length: 50
CDF05	Customer Defined Field - 5.	string	Max length: 50
CDF06	Customer Defined Field - 6.	string	Max length: 50
CDF07	Customer Defined Field - 7.	string	Max length: 50
CDF08	Customer Defined Field - 8.	string	Max length: 50
CDF09	Customer Defined Field - 9.	string	Max length: 50
CDF10	Customer Defined Field - 10.	string	Max length: 50
CustomerReference	Information defined by the customer for the purpose of Invoice reference.	string	Max length: 100
Manufacturer	Manufacturer of the Asset.	string	Max length: 64
Model	Model of the Asset.	string	Max length: 250
SiteAddress	Site address of the Asset.	string	Max length: 256
SiteCity	Site city of the Asset.	string	Max length: 256
SiteCountry	Site country of the Asset.	string	Max length: 256
SiteLocale	Site locale of the Asset.	string	Max length: 256
SitePostalCode	Site postal code of the Asset.	string	Max length: 10
SiteRegion	Site region of the Asset.	string	Max length: 256
SiteState	Site state of the Asset.	string	Max length: 256

Request Formats

application/json, text/json

Sample:

{
  "CMDB_ID": "sample string 1",
  "Schedule": "sample string 2",
  "Serial": "sample string 3",
  "Manufacturer": "sample string 4",
  "Model": "sample string 5",
  "CustomerReference": "sample string 6",
  "CDF01": "sample string 7",
  "CDF02": "sample string 8",
  "CDF03": "sample string 9",
  "CDF04": "sample string 10",
  "CDF05": "sample string 11",
  "CDF06": "sample string 12",
  "CDF07": "sample string 13",
  "CDF08": "sample string 14",
  "CDF09": "sample string 15",
  "CDF10": "sample string 16",
  "SiteAddress": "sample string 17",
  "SiteCity": "sample string 18",
  "SiteState": "sample string 19",
  "SiteLocale": "sample string 20",
  "SiteRegion": "sample string 21",
  "SitePostalCode": "sample string 22",
  "SiteCountry": "sample string 23"
}

application/octet-stream

Sample:

{"CMDB_ID":"sample string 1","Schedule":"sample string 2","Serial":"sample string 3","Manufacturer":"sample string 4","Model":"sample string 5","CustomerReference":"sample string 6","CDF01":"sample string 7","CDF02":"sample string 8","CDF03":"sample string 9","CDF04":"sample string 10","CDF05":"sample string 11","CDF06":"sample string 12","CDF07":"sample string 13","CDF08":"sample string 14","CDF09":"sample string 15","CDF10":"sample string 16","SiteAddress":"sample string 17","SiteCity":"sample string 18","SiteState":"sample string 19","SiteLocale":"sample string 20","SiteRegion":"sample string 21","SitePostalCode":"sample string 22","SiteCountry":"sample string 23"}

application/xml, text/xml

Sample:

<CMDB_Asset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.CMDB">
  <CDF01>sample string 7</CDF01>
  <CDF02>sample string 8</CDF02>
  <CDF03>sample string 9</CDF03>
  <CDF04>sample string 10</CDF04>
  <CDF05>sample string 11</CDF05>
  <CDF06>sample string 12</CDF06>
  <CDF07>sample string 13</CDF07>
  <CDF08>sample string 14</CDF08>
  <CDF09>sample string 15</CDF09>
  <CDF10>sample string 16</CDF10>
  <CMDB_ID>sample string 1</CMDB_ID>
  <CustomerReference>sample string 6</CustomerReference>
  <Manufacturer>sample string 4</Manufacturer>
  <Model>sample string 5</Model>
  <Schedule>sample string 2</Schedule>
  <Serial>sample string 3</Serial>
  <SiteAddress>sample string 17</SiteAddress>
  <SiteCity>sample string 18</SiteCity>
  <SiteCountry>sample string 23</SiteCountry>
  <SiteLocale>sample string 20</SiteLocale>
  <SitePostalCode>sample string 22</SitePostalCode>
  <SiteRegion>sample string 21</SiteRegion>
  <SiteState>sample string 19</SiteState>
</CMDB_Asset>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultModel

Name	Description	Type	Additional information
ErrorMessage	Optional error message provided by the method call.	string	None.
Message	Optional message provided by the method call.	string	None.
StatusCode	The HTTP Status Code of the method call.	HttpStatusCode	None.
Success	Boolean flag indicating the success or failure of the method call.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": "sample string 3",
  "StatusCode": 100
}

application/octet-stream

Sample:

{"Success":true,"Message":"sample string 2","ErrorMessage":"sample string 3","StatusCode":100}

application/xml, text/xml

Sample:

<ResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">
  <ErrorMessage>sample string 3</ErrorMessage>
  <Message>sample string 2</Message>
  <StatusCode>Continue</StatusCode>
  <Success>true</Success>
</ResultModel>