POST api/v2/items

Create (and enroll) new item. Manufacturer can be provided by Name or EntityID. If manufacturer name is provided and manufacturer does not exist, it will be created. Model can be provided by Name, Code or EntityID. If name is provided and model does not exist, it will be created. If more than one model with same Name or Code found, manufacturer must be provided for API to select proper model.

Request Information

URI Parameters

None.

Body Parameters

Item object

Item

Name	Description	Type	Additional information
parent-item	Parent item details	ItemSimple	None.
name	Name of the item	string	None.
foreign-id	Identifier from remote application	string	None.
group-name	Name of the group this item belong to.	string	None.
serial	Unique serial number usually assigned by manufacturer	string	None.
description	Description text	string	None.
comments	Free form text	string	None.
first-use-date	Date this entity was first used (used in service module)	date	None.
manufacturer	Manufacturer details	ManufacturerSimple	None.
model	Model details	ModelSimple	None.
expected-location	Expected location details	LocationSimple	None.
class	Item class details	ClassSimple	None.
department	Department details which is assigned to this item	DepartmentSimple	None.
project	Project details which is assigned to this item	ProjectSimple	None.
custodian	Custodian details	UserSimple	None.
attributes	Attributes meta and values associated with the entity	Collection of AttributeValueSimple	None.
tags	Tags associated with the item	Collection of TagSimple	None.

Request Formats

application/xml, text/xml

Sample:

<item xmlns="urn:tagvue:am">
  <parent-item entity-id="sample string 2">
    <name>sample string 1</name>
  </parent-item>
  <name>sample string 1</name>
  <foreign-id>sample string 2</foreign-id>
  <group-name>sample string 3</group-name>
  <serial>sample string 4</serial>
  <description>sample string 5</description>
  <comments>sample string 6</comments>
  <first-use-date>2025-05-30T18:55:22.476317-07:00</first-use-date>
  <manufacturer entity-id="sample string 2">
    <name>sample string 1</name>
  </manufacturer>
  <model entity-id="sample string 3">
    <name>sample string 1</name>
    <code>sample string 2</code>
  </model>
  <expected-location entity-id="sample string 2">
    <name>sample string 1</name>
  </expected-location>
  <class entity-id="sample string 2">
    <name>sample string 1</name>
  </class>
  <department entity-id="sample string 3">
    <name>sample string 1</name>
    <code>sample string 2</code>
  </department>
  <project entity-id="sample string 3">
    <name>sample string 1</name>
    <code>sample string 2</code>
  </project>
  <custodian entity-id="sample string 1">
    <name>sample string 2</name>
    <email>sample string 3</email>
    <employee-id>sample string 4</employee-id>
    <phone>sample string 5</phone>
  </custodian>
  <attributes>
    <attribute entity-id="sample string 2">
      <meta-data entity-id="sample string 2">
        <name>sample string 1</name>
        <type>Number</type>
      </meta-data>
      <value>sample string 1</value>
    </attribute>
    <attribute entity-id="sample string 2">
      <meta-data entity-id="sample string 2">
        <name>sample string 1</name>
        <type>Number</type>
      </meta-data>
      <value>sample string 1</value>
    </attribute>
  </attributes>
  <tags>
    <tag entity-id="sample string 1">
      <status>inactive</status>
    </tag>
    <tag entity-id="sample string 1">
      <status>inactive</status>
    </tag>
  </tags>
</item>

application/json, text/json

Sample:

{
  "parent-item": {
    "name": "sample string 1",
    "entity-id": "sample string 2"
  },
  "name": "sample string 1",
  "foreign-id": "sample string 2",
  "group-name": "sample string 3",
  "serial": "sample string 4",
  "description": "sample string 5",
  "comments": "sample string 6",
  "first-use-date": "2025-05-30T18:55:22.476317-07:00",
  "manufacturer": {
    "name": "sample string 1",
    "entity-id": "sample string 2"
  },
  "model": {
    "name": "sample string 1",
    "code": "sample string 2",
    "entity-id": "sample string 3"
  },
  "expected-location": {
    "name": "sample string 1",
    "entity-id": "sample string 2"
  },
  "class": {
    "name": "sample string 1",
    "entity-id": "sample string 2"
  },
  "department": {
    "name": "sample string 1",
    "code": "sample string 2",
    "entity-id": "sample string 3"
  },
  "project": {
    "name": "sample string 1",
    "code": "sample string 2",
    "entity-id": "sample string 3"
  },
  "custodian": {
    "entity-id": "sample string 1",
    "name": "sample string 2",
    "email": "sample string 3",
    "employee-id": "sample string 4",
    "phone": "sample string 5"
  },
  "attributes": [
    {
      "metadata": {
        "name": "sample string 1",
        "type": "Number",
        "entity-id": "sample string 2"
      },
      "value": "sample string 1",
      "entity-id": "sample string 2"
    },
    {
      "metadata": {
        "name": "sample string 1",
        "type": "Number",
        "entity-id": "sample string 2"
      },
      "value": "sample string 1",
      "entity-id": "sample string 2"
    }
  ],
  "tags": [
    {
      "status": 0,
      "entity-id": "sample string 1"
    },
    {
      "status": 0,
      "entity-id": "sample string 1"
    }
  ]
}

Response Information

Resource Description

Returns CREATED (201) if operation was succesfull or BAD REQUEST (400) if received object is invalid

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.