Entity API / createAsset

Operation Information

Application Reference: com.hornbill.servicemanager
Scope: Entity - Asset
Class: Entity
Required Privilege Level: none
Required Rights: none

Description

This flowcode operation creates an asset of the class passed in.

Request Parameters

The createAsset API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name	Type	Required	Description
`assetClass`	`xs:string`	No	The class of the asset being created
`generalProperties`	`xs:string`	No	JSON string of the properties to use to populate the asset details
`additionalProperties`	`xs:string`	No	JSON string of the properties to use to populate the asset extended details

Response Parameters

Name	Type	Description
`assetId`	`xs:string`	The Id of the new asset.
`exceptionName`	`xs:string`	The name / code of any exception thrown during the creation of the asset.
`exceptionSummary`	`xs:string`	A description of any exception thrown during the creation of the asset.

Code Examples

      curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Asset' \
   -H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
   -H 'Content-Type: application/json' \
   -d '{"@service":"apps/com.hornbill.servicemanager/Asset","@method":"createAsset","params":{"assetClass":"xs:string","generalProperties":"xs:string","additionalProperties":"xs:string"}}'

      package main
import (
    "fmt"
    apiLib "github.com/hornbill/goApiLib"
)
func main() {
	hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
	hornbillAPI.SetAPIKey("yourHornbillAPIKey")
	hornbillAPI.SetJSONResponse(true)
	hornbillAPI.SetParam("assetClass", "xs:string")
	hornbillAPI.SetParam("generalProperties", "xs:string")
	hornbillAPI.SetParam("additionalProperties", "xs:string")
	responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Asset", "createAsset")
	if apiError != nil {
		fmt.Println(apiError)
		return
	}
	fmt.Println(responseBody)
}

      const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Asset";
const payload = {
  "@service": "apps/com.hornbill.servicemanager/Asset",
  "@method": "createAsset",
  "params": {
    "assetClass": "xs:string",
    "generalProperties": "xs:string",
    "additionalProperties": "xs:string"
  }
};
fetch(endpoint, {
  method: 'POST',
  headers: {
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
  },
  body: JSON.stringify(payload)
}).then(res => res.json())
  .then(res => console.log(res));

      const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Asset";
const payload = {
  "@service": "apps/com.hornbill.servicemanager/Asset",
  "@method": "createAsset",
  "params": {
    "assetClass": "xs:string",
    "generalProperties": "xs:string",
    "additionalProperties": "xs:string"
  }
};
const axiosConfig = {
  headers: {
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
  }
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
    console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
    console.log("AXIOS ERROR: ", err);
})

      $endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Asset";
$payload = (object) [
    '@service' => 'apps/com.hornbill.servicemanager/Asset',
    '@method' => 'createAsset',
    'params' => (object) [
        'assetClass' => 'xs:string',
        'generalProperties' => 'xs:string',
        'additionalProperties' => 'xs:string',
    ]
];
$headers = [
    'Authorization: ESP-APIKEY yourHornbillAPIKey',
    'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;

      $Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Asset"
$Body = @{
	"@service" = "apps/com.hornbill.servicemanager/Asset"
	"@method" = "createAsset"
	params = @{
		assetClass = "xs:string"
		generalProperties = "xs:string"
		additionalProperties = "xs:string"
	}
}
$Header = @{
	"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
	Method      = "POST"
	Uri         = $Endpoint
	Headers     = $Header
	Body        = ($Body | ConvertTo-Json)
	ContentType = "application/json"
}
Invoke-RestMethod @Parameters

      import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Asset"
headers = {   
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
        "@service":"apps/com.hornbill.servicemanager/Asset",
        "@method":"createAsset",
        "params":{
            "assetClass":"xs:string",
            "generalProperties":"xs:string",
            "additionalProperties":"xs:string",
        },
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}

{{resultItem.title}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}