PUT api/v2/operations
Execute common operations. Operation type identified by the property of the operationData. Some operations may have dedicated API endpoint, check documentation.
Request Information
URI Parameters
None.
Body Parameters
Provides input data for operation.
OperationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| operation-type |
Type of operation |
OperationType |
None. |
| location-entity-id |
Entity identificator of the location, where operation performed |
string |
None. |
| username |
Username of the person who perfromed operation |
string |
None. |
| item-tags |
Tags of the items taking part in operation. Either this list or item-entity-id-list should be provided. If item-entity-id-list is provided, system ignores this list. |
Collection of string |
None. |
| item-entity-id-list |
EntityID of the items taking part in operation. Either this list or item-tags should be provided. If this list is provided, system ignores item-tags. |
Collection of string |
None. |
| ignore-warning |
If this flag is set, API will ignore any warnings from the business logic, such as checkout not full kit - as example. Usual case scenario: cloient application executes operation with this flag OFF. If API responds with warning, client application asks user for confirmation and repeats operation with this flag ON. |
boolean |
None. |
Request Formats
application/xml, text/xml
Sample:
<operation-request xmlns="urn:tagvue:am"> <operation-type>CheckIn</operation-type> <location-entity-id>sample string 1</location-entity-id> <username>sample string 2</username> <item-tags>sample string 1</item-tags> <item-tags>sample string 2</item-tags> <item-entity-id-list>sample string 1</item-entity-id-list> <item-entity-id-list>sample string 2</item-entity-id-list> <ignore-warning>true</ignore-warning> </operation-request>
application/json, text/json
Sample:
{
"operation-type": "checkin",
"location-entity-id": "sample string 1",
"username": "sample string 2",
"item-tags": [
"sample string 1",
"sample string 2"
],
"item-entity-id-list": [
"sample string 1",
"sample string 2"
],
"ignore-warning": true
}
Response Information
Resource Description
OperationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| status |
Operation result status |
OperationResultStatus |
None. |
| message |
Message, optional |
string |
None. |
| operation-items |
Subset of items, included in to operation with statuses. Some items can be omitted, see particular operation documentation for details. |
Collection of OperationItemStatus |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": "none",
"message": "sample string 1",
"operation-items": [
{
"item-entity-id": "sample string 1",
"item-name": "sample string 2",
"item": {
"name": "sample string 1",
"description": "sample string 2",
"group-name": "sample string 3",
"state": "notreceived",
"serial": "sample string 4",
"create-date": "2025-05-30T20:07:56.5161949-07:00",
"update-date": "2025-05-30T20:07:56.5161949-07:00",
"first-use-time": "2025-05-30T20:07:56.5161949-07:00",
"attributes": [
{
"name": "sample string 1",
"type": "Number",
"value": "sample string 2",
"person": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"entity-id": "sample string 3"
},
{
"name": "sample string 1",
"type": "Number",
"value": "sample string 2",
"person": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"entity-id": "sample string 3"
}
],
"class": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"department": {
"name": "sample string 1",
"code": "sample string 2",
"entity-id": "sample string 3"
},
"last-seen-location": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"last-seen-time": "2025-05-30T20:07:56.5161949-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"
},
"project": {
"name": "sample string 1",
"code": "sample string 2",
"entity-id": "sample string 3"
},
"parent": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"tags": [
{
"last-seen-time": "2025-05-30T20:07:56.5161949-07:00",
"last-seen-location": {
"entity-id": "sample string 1"
},
"last-seen-provider": 1,
"latitude": 1.1,
"longitude": 1.1,
"last-seen-x-coordinate": 1.1,
"last-seen-y-coordinate": 1.1,
"status": 0,
"entity-id": "sample string 2"
},
{
"last-seen-time": "2025-05-30T20:07:56.5161949-07:00",
"last-seen-location": {
"entity-id": "sample string 1"
},
"last-seen-provider": 1,
"latitude": 1.1,
"longitude": 1.1,
"last-seen-x-coordinate": 1.1,
"last-seen-y-coordinate": 1.1,
"status": 0,
"entity-id": "sample string 2"
}
],
"custodian": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"status": 0,
"entity-id": "sample string 7"
},
"original-id": "sample string 3",
"message": "sample string 4",
"status": "none"
},
{
"item-entity-id": "sample string 1",
"item-name": "sample string 2",
"item": {
"name": "sample string 1",
"description": "sample string 2",
"group-name": "sample string 3",
"state": "notreceived",
"serial": "sample string 4",
"create-date": "2025-05-30T20:07:56.5161949-07:00",
"update-date": "2025-05-30T20:07:56.5161949-07:00",
"first-use-time": "2025-05-30T20:07:56.5161949-07:00",
"attributes": [
{
"name": "sample string 1",
"type": "Number",
"value": "sample string 2",
"person": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"entity-id": "sample string 3"
},
{
"name": "sample string 1",
"type": "Number",
"value": "sample string 2",
"person": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"entity-id": "sample string 3"
}
],
"class": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"department": {
"name": "sample string 1",
"code": "sample string 2",
"entity-id": "sample string 3"
},
"last-seen-location": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"last-seen-time": "2025-05-30T20:07:56.5161949-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"
},
"project": {
"name": "sample string 1",
"code": "sample string 2",
"entity-id": "sample string 3"
},
"parent": {
"name": "sample string 1",
"entity-id": "sample string 2"
},
"tags": [
{
"last-seen-time": "2025-05-30T20:07:56.5161949-07:00",
"last-seen-location": {
"entity-id": "sample string 1"
},
"last-seen-provider": 1,
"latitude": 1.1,
"longitude": 1.1,
"last-seen-x-coordinate": 1.1,
"last-seen-y-coordinate": 1.1,
"status": 0,
"entity-id": "sample string 2"
},
{
"last-seen-time": "2025-05-30T20:07:56.5161949-07:00",
"last-seen-location": {
"entity-id": "sample string 1"
},
"last-seen-provider": 1,
"latitude": 1.1,
"longitude": 1.1,
"last-seen-x-coordinate": 1.1,
"last-seen-y-coordinate": 1.1,
"status": 0,
"entity-id": "sample string 2"
}
],
"custodian": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"status": 0,
"entity-id": "sample string 7"
},
"original-id": "sample string 3",
"message": "sample string 4",
"status": "none"
}
]
}