POST api/v2/tags/search?intent={intent}&field[0]={field[0]}&field[1]={field[1]}
Get tags entity details by list of epcs
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| intent |
Indicates the reason why entities are requested. If provided, checking is done whether entity can be used for the operation. Valid values: none - no checking; checkin - is entity ready for checking; checkout - is entity ready for checkout; submit - is entity ready for submit; pickup - is entity ready for pickup; |
TagSearchIntent |
Default value is None |
| field |
Optional. If intent = Info, this list provides additional fields to return for each tag. |
Collection of TagSearchField |
None. |
Body Parameters
List of EPCs
Collection of stringRequest Formats
application/xml, text/xml
Sample:
<ArrayOfString> <string>sample string 1</string> <string>sample string 2</string> </ArrayOfString>
application/json, text/json
Sample:
[ "sample string 1", "sample string 2" ]
Response Information
Resource Description
Entity details collection
TagSearchList| Name | Description | Type | Additional information |
|---|---|---|---|
| items |
Items collections |
Collection of ItemTag |
None. |
| people |
People collections |
Collection of UserTag |
None. |
Response Formats
application/json, text/json
Sample:
{
"items": [
{
"name": "sample string 1",
"model": "sample string 2",
"manufacturer": "sample string 3",
"serial": "sample string 4",
"item-class": "sample string 5",
"project": {
"name": "sample string 1",
"code": "sample string 2",
"entity-id": "sample string 3"
},
"tags": [
"sample string 1",
"sample string 2"
],
"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"
}
],
"current-user": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"custodian": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"operation-ready": true,
"operation-message": "sample string 6",
"entity-id": "sample string 7"
},
{
"name": "sample string 1",
"model": "sample string 2",
"manufacturer": "sample string 3",
"serial": "sample string 4",
"item-class": "sample string 5",
"project": {
"name": "sample string 1",
"code": "sample string 2",
"entity-id": "sample string 3"
},
"tags": [
"sample string 1",
"sample string 2"
],
"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"
}
],
"current-user": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"custodian": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
},
"operation-ready": true,
"operation-message": "sample string 6",
"entity-id": "sample string 7"
}
],
"people": [
{
"name": "sample string 1",
"username": "sample string 2",
"email": "sample string 3",
"phone": "sample string 4",
"checkout-item-count": 1,
"tags": [
"sample string 1",
"sample string 2"
],
"entity-id": "sample string 5"
},
{
"name": "sample string 1",
"username": "sample string 2",
"email": "sample string 3",
"phone": "sample string 4",
"checkout-item-count": 1,
"tags": [
"sample string 1",
"sample string 2"
],
"entity-id": "sample string 5"
}
]
}